Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>

Default workspace for the new key when scopedWorkspaceIds is omitted.

Body

application/json
name
string
required
Required string length: 1 - 100
scoped_workspace_ids
string<uuid>[] | null
deprecated

Deprecated alias of scopedWorkspaceIds, removed at the API sunset. Read scopedWorkspaceIds.

scopes
enum<string>[] | null
Minimum array length: 1
Available options:
read,
write,
outreach
expires_at
string<date-time> | null
deprecated

Deprecated alias of expiresAt, removed at the API sunset. Read expiresAt.

scopedWorkspaceIds
string<uuid>[] | null
expiresAt
string<date-time> | null

Response

Created; key is shown only here

data
object
required