API key scopes
Every scope an API key or connected app can hold.
A scope is <resource>:read, <resource>:write or admin. When you create a key you may ask for <resource>:*, which grants both. write does not imply read.
Only an admin or owner may grant admin. A key is also capped by its creator's current role: if the person is demoted or removed, their keys lose that access too.
| Scope | Allows | Core routes |
|---|---|---|
leads:read | Read leads, companies, timelines, imports and contactability | 30 |
leads:write | Create, update and delete leads and companies; notes, imports, enrichment, research | 24 |
compliance:read | Read consents, suppressions and the calling policy | 6 |
compliance:write | Record consents and opt-outs; manage suppressions | 5 |
sequences:read | Read sequences, steps, enrollments and email drafts | 5 |
sequences:write | Manage sequences and steps, enroll and unenroll leads, approve drafts | 17 |
replies:read | Read replies and reply drafts | 1 |
replies:write | Approve, reject and send reply drafts; draft new emails for review | 1 |
calls:read | Read calls, transcripts and analyses | 6 |
calls:write | Place and manage calls | 0 |
mailboxes:read | Read connected mailboxes | 4 |
mailboxes:write | Connect, update and disconnect mailboxes; send email | 6 |
analytics:read | Read analytics summaries and time series | 4 |
exports:read | List exports and fetch their download links | 2 |
exports:write | Export lists as CSV/XLSX (starts exports) | 9 |
kb:read | Read and search the knowledge base | 0 |
kb:write | Add and remove knowledge base documents | 0 |
workspace:read | Read the workspace, members, profile and settings | 8 |
notifications:read | Read in-app notifications | 2 |
notifications:write | Mark in-app notifications read | 2 |
crm:read | Read deals, pipelines, tasks, notes and activities | 13 |
crm:write | Create, update and delete deals, pipelines, tasks, notes and activities | 25 |
agents:read | Read the Agents hub: agents, settings and activity | 2 |
agents:write | Change agents' on/off, pause, autonomy and schedule | 1 |
admin | Workspace administration (settings, members, audit log, webhooks, privacy requests); needs the admin role | 55 |
Each page in the API reference shows the scope its route needs.