Skip to main content
POST
Issue an API key

Authorizations

X-API-KEY
string
header
required

Your partner API key, pk_…. Backend only.

Path Parameters

workspace
string<uuid>
required

A workspace uuid from provisioning. It must be administered by a customer you provisioned.

Body

application/json
name
string
required
Maximum string length: 80
Example:

"Dealer CRM"

scopes
string[]
required

Permissions, as in the dashboard.

Minimum array length: 1
Example:
expires_at
string<date-time> | null

A future time, or null for no expiry.

Example:

null

Response

Issued

success
boolean
Example:

true

message
string
Example:

"API key created. The token is shown once and cannot be retrieved again."

data
object