Skip to main content
GET
Get the current workspace and key scopes
Check the workspace and scopes associated with your API key.

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.

Response

Authenticated API key context.

apiKeyId
string
required
Example:

"key_o5mj4q7beg32vkjcd76a37t5zy"

workspaceId
string
required
Example:

"wsp_f46kbkltuw6uzkj7y2j4bbxlbe"

scopes
enum<string>[]
required

Workspace API key permission scope.

Available options:
customers:read,
customers:write,
conversations:read,
conversations:write,
messages:write,
attachments:read,
attachments:write,
webhooks:manage,
realtime:read,
ai:use,
keys:manage,
help:read,
help:drafts:write