Authentication

All API requests require authentication using an API key. Include your API key in the x-api-key header:

x-api-key: YOUR_API_KEY

Obtaining API Keys

Production Keys

API keys for production use can be generated from the Developer Dashboard:

1. Log in and navigate to the API Keys page
2. Click Create API Key
3. Give your key a descriptive name and select the exact capabilities it needs
4. Copy and securely store your API key; it will only be shown once

Testing in the API Playground

You can generate a temporary API key directly from the API reference pages to quickly test endpoints in the interactive playground.

1. Make sure you are logged in.
2. Navigate to any API reference page (e.g., List Campaigns)
3. Open the Authorization section in the playground
4. Click Generate API Key
5. If you belong to multiple organizations, select which one to create the key for

Rate Limiting

If you exceed the rate limit, you'll receive a 429 Too Many Requests response:

{
  "message": "Rate limit exceeded",
  "code": "RATE_LIMIT_EXCEEDED",
  "retryAfter": 60
}

Error Codes

All error responses follow a consistent format:

{
  "message": "<string>",
  "code": "<string>"
}