API keys
Keys let your own systems read this business through the external API. A key acts as your business, so keep it secret.
Create a key
API keys are included on Growth, Pro, and Enterprise plans. Starter plans do not include API keys.
API keys are not on your plan. Growth, Pro, and Enterprise plans include API keys — the creation form is hidden until your plan includes them.
Copy it now — it will never be shown again.
Your keys
Only the start of each key is shown here. The full key is never shown again after creation.
| Name | Key starts with | Last used | Status | Actions |
|---|---|---|---|---|
Usage per key
Which key called which endpoint, and when. This is the same record the business owner sees, key by key.
How to use the API, in plain words
Authenticate
Send your key in the Authorization header as Bearer YOUR_KEY, or in the x-api-key header. The key is sent over the connection each time; it is never stored in your browser.
Authorization: Bearer YOUR_KEY x-api-key: YOUR_KEY
Endpoints
| Method and path | Returns |
|---|---|
GET /api/external/usage | This business's plan and usage summary, the same counts shown on the Usage page. |
GET /api/external/contacts?page=1&limit=50 | Contacts in pages of up to 100, with only id, name, phone, tags, and blocked status. |
Rate limit
Each key may make 60 requests per minute. Past that, calls are refused with a rate-limited error until the minute passes.
Revoked keys
A revoked key stops working at once: the next call with it is refused as an invalid key. Revoking cannot be undone; create a new key instead.
Keep it secret
Your key acts as your business. Anyone holding it can read your contacts and usage. If a key may have leaked, revoke it here and create a new one.