Skip to main content
Every API key carries a list of scopes. A request fails with 403 FORBIDDEN if the key is missing any required scope, with a message like:

Available scopes

Each endpoint section in the API Reference lists the exact scope it requires.
Two endpoints intentionally bypass scope checks — they sit outside the authenticated, rate-limited surface so monitoring and connector “test connection” flows can use them without needing per-scope keys:
  • GET /health — no Authorization header at all. Public liveness + DB readiness probe.
  • GET /me — bearer required, but any valid bearer works (even one with an empty scope set). Returns the org and the bearer’s scopes.
Everything else requires at least one scope.

Personal credentials

A personal credential always uses the operational profile: leads:read, leads:write, pipeline:read, sequences:read, sequences:write, whatsapp:read, whatsapp:write. Those scopes still only apply inside the member’s portfolio and on routes that opt into member operations. Extra OAuth scopes are clipped. Listing members, projects, round robin, calendar, webhooks, or creating leads/sequences at org level returns 403 FORBIDDEN.

Choosing scopes

Common patterns:
  • Lead ingestion only (Meta Ads form, web form, landing page): leads:write.
  • Two-way sync (a CRM tool that needs to read and update leads): leads:read, leads:write.
  • BI / reporting (read-only dashboards): leads:read, projects:read, members:read.
  • Catalog publisher (sync units availability to a website): projects:read, projects:write.
  • Lead routing (auto-assign inbound leads across a team): round-robin:read, round-robin:write, leads:read.
  • Scheduling integration (read availability and book events on a member’s calendar): calendar:read, calendar:write, members:read.
  • Outbound automation (build, launch, and manage cold-outreach sequences): sequences:read, sequences:write, leads:read.
  • WhatsApp messaging (list sender accounts and send one-off WhatsApp messages): whatsapp:read, whatsapp:write, leads:read.
  • Member portfolio automation (Zapier/Make on assigned leads only): personal credential; see Personal API access.
  • Webhook orchestrator (Zapier, Make, n8n connectors): webhooks:manage plus the read/write scopes you actually use.
You can edit a key’s scopes in the dashboard at any time. Changes take effect on the next request.