Reference
API Key Scopes
Every Agoralia API key scope and exactly what it allows. Scope each key to only what your integration needs.
An Agoralia API key carries a set of scopes. Each endpoint
requires one specific scope; a request whose key lacks the scope returns
403 Missing scope: <scope>.
Scopes are chosen when you create a key in the dashboard at
app.agoralia.app → API Keys. Grant the minimum a given
integration needs — read-only keys for dashboards, write keys for automation.
There are 20 scopes, grouped by resource.
| Scope | Allows |
|---|
me:read | Read workspace info, billing plan/limits, and the key's own scopes (GET /me). |
| Scope | Allows |
|---|
agents:read | List and read voice agents. |
agents:write | Create, update, publish, and delete (deactivate) agents. |
| Scope | Allows |
|---|
campaigns:read | List and read campaigns. |
campaigns:write | Create, update, and cancel campaigns. |
campaigns:start | Start and pause campaigns. Separated from campaigns:write so a key can manage campaigns without being able to launch calls. |
| Scope | Allows |
|---|
leads:read | List leads in a campaign. |
leads:write | Add/upsert and delete leads. |
| Scope | Allows |
|---|
calls:read | List calls and read full call detail (transcript, summary, analysis, recording URL). |
calls:write | Place single outbound calls. |
| Scope | Allows |
|---|
results:read | Read campaign call results (GET /campaigns/{id}/results). |
| Scope | Allows |
|---|
numbers:read | List and read phone numbers. |
numbers:write | Link BYO numbers, configure inbound, and release numbers. |
| Scope | Allows |
|---|
billing:read | Read usage and plan limits (GET /billing/usage). |
| Scope | Allows |
|---|
compliance:read | List and check do-not-call (DNC) entries. |
compliance:write | Add and remove DNC entries. |
| Scope | Allows |
|---|
sms:read | Reserved for reading SMS / conversation data. |
sms:write | Send outbound SMS (POST /sms). |
| Scope | Allows |
|---|
webhooks:read | Read the event-webhook configuration (GET /webhooks). |
webhooks:write | Set the webhook URL, subscribed events, and rotate the signing secret (PUT /webhooks). |