Skip to main content
GET
Get platform settings
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.
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.

Response

object
Your platform settings, grouped by section
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.

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