Skip to main content
The key returned by POST /v1/platform/verify has empty scopes = ADMIN access (everything) during onboarding. In production, create restricted keys via POST /v1/platform/api-keys.

​
In short

  • Each API key belongs to one workspace.
  • Empty scopes on creation = full access (equivalent to ADMIN).
  • API keys use api_keys:read and api_keys:manage
  • Billing (plan, balance, cards, credit usage history) uses billing:read and billing:manage.
  • Team (members and invites) uses workspace:members:read and workspace:members:manage .
  • Messaging uses per-channel scopes documented in each API (WhatsApp, SMS, email…).
General guide: API Keys.

​
Scopes by area

With a login sessionToken, OWNER/ADMIN members can operate billing, keys, and team without scopes on the API key.

​
How to send the key

Alternative: x-api-key: sk_live_xxxxx.

​
API key routes (/v1/platform/api-keys)