Skip to main content
cURL

Authorizations

Authorization
string
header
required

Issued in Developers. Workspace/owner/scopes come from credential, never acting-user headers. API keys cannot manage API credentials.

Response

The authenticated credential, workspace, environment and granted scopes. No secret is included.

credentialId
string<uuid>
required

Identifier of the API key used for this request.

workspaceId
string
required

Workspace this key can access. Requests cannot select a different workspace.

kind
enum<string>
required

Personal keys follow one member; workspace keys use the configured member allowlist.

Available options:
personal,
workspace
ownerId
string | null
required

Member ID for a personal key; null for a workspace key.

allowedUserIds
string[]
required

Member IDs allowed by a workspace key. An empty array means all owners in that workspace; it does not widen a personal key.

scopes
enum<string>[]
required

Permissions granted to this key.

Available options:
contacts:read,
contacts:write,
lists:read,
lists:write,
calls:read,
recordings:read,
transcripts:read,
analytics:read,
changes:read,
webhooks:manage
environment
enum<string>
required

Environment the key was issued for.

Available options:
live,
test
apiVersion
enum<string>
required

Version of the public API.

Available options:
v2