Scopes
48 scopes across 23 resources. Every operation in this reference declares exactly one.
This table is generated from the same authorization table the server enforces. It is not a hand-maintained copy, so it cannot disagree with what the API actually does.
Shape
Scopes are resource.action. read covers listing and fetching; write covers create, update and delete unless a narrower scope exists (for example flows.publish and flows.delete are separate from flows.write, because editing a draft and publishing it are different acts).
All scopes
| Scope | Operations |
|---|---|
agents.lifecycle | 6 |
agents.read | 13 |
agents.write | 8 |
analytics.read | 10 |
appointments.read | 1 |
appointments.write | 3 |
billing.read | 10 |
campaigns.read | 4 |
campaigns.write | 7 |
catalog.read | 1 |
catalog.write | 5 |
channels.read | 6 |
channels.write | 6 |
contacts.export | 1 |
contacts.import | 1 |
contacts.read | 3 |
contacts.write | 1 |
conversation_stages.write | 3 |
conversations.read | 7 |
conversations.write | 6 |
crm.cards.write | 5 |
crm.read | 4 |
crm.structure.write | 7 |
developers.read | 7 |
developers.write | 5 |
flows.delete | 1 |
flows.publish | 1 |
flows.read | 3 |
flows.write | 2 |
integrations.read | 4 |
integrations.write | 6 |
knowledge.read | 3 |
knowledge.write | 16 |
leads.export | 1 |
leads.read | 2 |
leads.write | 3 |
library.read | 2 |
library.write | 7 |
meta_catalog.read | 3 |
meta_catalog.write | 4 |
orders.read | 3 |
orders.write | 3 |
service_policy.read | 1 |
service_policy.write | 1 |
team.read | 3 |
whatsapp_templates.read | 2 |
whatsapp_templates.write | 4 |
workspace.read | 5 |
What a key can never hold
Some capabilities exist for people and not for programs, and they are absent from this table on purpose: your own profile, password, email and sessions; team administration; API-key management; subscription changes; campaign dispatch and its LGPD consent attestation; and the internal platform admin surface. A key presenting any of those gets 403 FORBIDDEN, and no scope grant changes that.