Authentication

Log in to see your API keys
API KeyLabelLast Used

Authenticate every request with a per-tenant API key, sent in either header:

X-API-Key: ck_xxxxxxxxxxxxxxxxxxxxxxxx
Authorization: Bearer ck_xxxxxxxxxxxxxxxxxxxxxxxx

A key resolves to exactly one tenant and can only see and act on that tenant's data. A missing or unknown key returns 401.

Permissions

Each key holds a set of per-feature permissions (<feature>:<op>). A request whose key lacks the required permission returns 403.

FeatureOperations
Callscalls:read (list / view), calls:control (call actions: hangup, hold, transfer, bridge, transfer-to-queue / agent, join-conference)
Queuesqueues:read, queues:create, queues:update, queues:delete
Conferencesconferences:read, conferences:create, conferences:update, conferences:delete, conferences:control (member ops)
Leadsleads:read, leads:create, leads:update, leads:delete
Campaignscampaigns:read, campaigns:create, campaigns:update, campaigns:delete
Listslists:read, lists:create, lists:update, lists:delete
Usersusers:read, users:create, users:update, users:delete
Extensionsextensions:read, extensions:create, extensions:update, extensions:delete

Secrets are write-only: user passwords are stored hashed, extension SIP passwords encrypted, and neither (nor voicemail PINs) is ever returned.

Create keys and choose their per-feature permissions in Control Panel → API Keys.

Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!