ZapyFlow/API documentationopenapi.json

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

ScopeOperations
agents.lifecycle6
agents.read13
agents.write8
analytics.read10
appointments.read1
appointments.write3
billing.read10
campaigns.read4
campaigns.write7
catalog.read1
catalog.write5
channels.read6
channels.write6
contacts.export1
contacts.import1
contacts.read3
contacts.write1
conversation_stages.write3
conversations.read7
conversations.write6
crm.cards.write5
crm.read4
crm.structure.write7
developers.read7
developers.write5
flows.delete1
flows.publish1
flows.read3
flows.write2
integrations.read4
integrations.write6
knowledge.read3
knowledge.write16
leads.export1
leads.read2
leads.write3
library.read2
library.write7
meta_catalog.read3
meta_catalog.write4
orders.read3
orders.write3
service_policy.read1
service_policy.write1
team.read3
whatsapp_templates.read2
whatsapp_templates.write4
workspace.read5

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.