How do I send my key?
Authorization: Bearer ec_live_…Keys start with ec_live_ and end with a checksum, so a mistyped key is refused at once and secret scanners can spot one pushed to a repository.
How do I create, scope and revoke keys?
- Only the workspace owner can create or revoke keys, on Developers in the dashboard. Each create and revoke appears in your notifications.
- A key is shown once, when it is created. We keep only a fingerprint, so a lost key cannot be shown again: create a new one.
- Up to 10 active keys per workspace. You can give a key an expiry date.
- Use one key per integration, so you can revoke one without touching the others. Revoking takes effect immediately.
| Access | Can |
|---|---|
| Full access | Everything: place and cancel calls, run campaigns, manage contacts, do-not-call and webhooks. Creating one records your confirmation that the people you call agreed to hear from you. |
| Read only | Read employees, numbers, coins, calls, leads, campaigns, contacts, appointments, do-not-call, webhooks and events. Any write answers 403 insufficient_scope. |
Can I call the API from a web page?
No. A key in a web page or mobile app can be copied by anyone, so requests sent from a browser are refused with 403 browser_requests_not_allowed. Call the API from your server or automation tool.
What do authentication errors mean?
| Status | code | Meaning |
|---|---|---|
| 401 | missing_api_key | No Authorization: Bearer header. |
| 401 | invalid_api_key | Not a key we know (mistyped or deleted). |
| 401 | api_key_revoked | The key was revoked. |
| 401 | api_key_expired | The key passed the expiry chosen when it was created. |
| 403 | account_inactive | The workspace is suspended or closed. |
| 403 | insufficient_scope | A read-only key was used for a write. |
| 403 | browser_requests_not_allowed | The request came from a web page. |
Ready to try it? Sign in and open Developers to create a key, or ask us about your integration.