> ## Documentation Index
> Fetch the complete documentation index at: https://docs.autocalls.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get platform settings

> Get the settings of your white label platform

This endpoint returns the settings of your white label platform that you can also change through the API. Each section matches a tab of **Settings** in your administration panel: `welcome_email` (Email Templates), `email_notifications` (Email Notifications), `scripts` (Custom Scripts), `appearance` (Custom Appearance), `webhooks` (Webhooks) and `checkout` (Checkout). Other settings, such as branding, custom domain and SMTP, are managed in the administration panel only.

<Note>
  This endpoint is available to the **account owner** (with an active plan) and to team members with **Settings Access**. The `checkout` section is only included for the owner and for team members who also have **Billing Access**. Other users receive a 403 Forbidden error.
</Note>

### Response

<ResponseField name="data" type="object">
  Your platform settings, grouped by section

  <Expandable title="data properties">
    <ResponseField name="welcome_email" type="object">
      The welcome email sent to new users. Every key is a string, or `null` when the default text is used.

      <Expandable title="welcome_email properties">
        <ResponseField name="subject" type="string">
          Email subject
        </ResponseField>

        <ResponseField name="preheader" type="string">
          Preview text shown in the inbox before the email is opened
        </ResponseField>

        <ResponseField name="greeting_text" type="string">
          Heading at the top of the email
        </ResponseField>

        <ResponseField name="content" type="string">
          Main body of the email, in HTML
        </ResponseField>

        <ResponseField name="journey_text" type="string">
          Message shown before the contact details
        </ResponseField>

        <ResponseField name="questions_text" type="string">
          Text shown before the contact email
        </ResponseField>

        <ResponseField name="contact_email" type="string">
          Support email address shown in the email
        </ResponseField>

        <ResponseField name="signature_text" type="string">
          Signature at the end of the email
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="email_notifications" type="object">
      One boolean per email your users can receive: `true` means the email is sent. Also contains `automation_usage_alert_email`, the address that receives automation usage alerts instead of your users, or `null` when each user receives their own. `trial_ending_reminder` is only included when free trials are enabled for your platform. See [Update platform settings](/api-reference/white-label/update-settings) for what each email is.
    </ResponseField>

    <ResponseField name="scripts" type="object">
      Your custom scripts

      <Expandable title="scripts properties">
        <ResponseField name="scripts" type="string">
          Code added to every page your users see once logged in, or `null`
        </ResponseField>

        <ResponseField name="scripts_auth" type="string">
          Code added to the login and sign-up pages, or `null`
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="appearance" type="object">
      What your users see on your platform

      <Expandable title="appearance properties">
        <ResponseField name="hide_pages" type="string[]">
          Pages hidden from your users' navigation
        </ResponseField>

        <ResponseField name="hide_features" type="string[]">
          Features and buttons hidden from your users
        </ResponseField>

        <ResponseField name="hide_countries" type="string[]">
          Country codes hidden when your users buy a phone number
        </ResponseField>

        <ResponseField name="plan_billing_display" type="string">
          Billing cycles shown on the plans page: `both`, `monthly` or `yearly`
        </ResponseField>

        <ResponseField name="relabel_minutes_as_credits" type="boolean">
          Whether "Minutes" is shown to your users as "Calling credits"
        </ResponseField>

        <ResponseField name="allow_sign_ups" type="boolean">
          Whether visitors can create an account on your platform. `true` unless you turned sign-ups off
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="webhooks" type="object">
      Your webhooks

      <Expandable title="webhooks properties">
        <ResponseField name="user_signup_webhook_url" type="string">
          The URL called each time a new user signs up, or `null` when the webhook is off
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="checkout" type="object">
      Your checkout settings. Only included for the owner and for team members with **Billing Access**.

      <Expandable title="checkout properties">
        <ResponseField name="require_tax_id" type="boolean">
          Whether customers must enter a VAT or tax ID at checkout
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

The allowed values of every key, the placeholders you can use in the welcome email and the signup webhook payload are described in [Update platform settings](/api-reference/white-label/update-settings).

<ResponseExample>
  ```json 200 Response theme={null}
  {
    "data": {
      "welcome_email": {
        "subject": "Welcome to {tenant_name}, {user_name}!",
        "preheader": null,
        "greeting_text": "Welcome {user_name}!",
        "content": "<p>Thanks for joining {tenant_name}. Your account is ready.</p>",
        "journey_text": null,
        "questions_text": "If you have any questions, reach out to:",
        "contact_email": "support@example.com",
        "signature_text": "Best,<br>{tenant_name} team"
      },
      "email_notifications": {
        "welcome_email": true,
        "low_balance_alert": true,
        "auto_topup_notification": true,
        "low_chat_credits_alert": true,
        "chat_credits_auto_topup_notification": true,
        "trial_ending_reminder": true,
        "voice_cloning_completed": true,
        "phone_number_deleted": true,
        "import_completed": true,
        "export_completed": false,
        "automation_usage_alert": true,
        "automation_usage_alert_email": null
      },
      "scripts": {
        "scripts": "<script src=\"https://chat.example.com/widget.js\" async></script>",
        "scripts_auth": null
      },
      "appearance": {
        "hide_pages": ["hide_api_page", "hide_blacklist_page"],
        "hide_features": ["hide_carrier_costs", "hide_platform_tour"],
        "hide_countries": [],
        "plan_billing_display": "both",
        "relabel_minutes_as_credits": false,
        "allow_sign_ups": true
      },
      "webhooks": {
        "user_signup_webhook_url": "https://example.com/hooks/signup"
      },
      "checkout": {
        "require_tax_id": false
      }
    }
  }
  ```

  ```json 401 Unauthenticated theme={null}
  {
    "message": "Unauthenticated."
  }
  ```

  ```json 403 Not Administrator theme={null}
  {
    "message": "You are not an administrator."
  }
  ```

  ```json 403 No Settings Access theme={null}
  {
    "message": "You do not have access to these settings."
  }
  ```

  ```json 429 Too Many Requests theme={null}
  {
    "message": "Too Many Attempts."
  }
  ```
</ResponseExample>

### Rate limit

The platform settings, default limits, user settings and plan endpoints share a limit of 60 requests per minute for each account. Above it they return `429`, and the `Retry-After` response header tells you how many seconds to wait.

### Example

```bash theme={null}
curl -X GET https://app.autocalls.ai/api/white-label/settings \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.