API Keys

Create Api Key

Create a new API key for the current business.

The request body is optional; omitting it creates a key with the default scope (admin) and expiry (365 days). The plaintext key is returned once in this response and never again; only its HMAC-SHA256 hash and a masked prefix are persisted.

Security: Store this key securely - it won't be shown again!

post/api/v1/api-keys

Request body

namestring nullable
scopesApiKeyScope[]
expires_in_daysinteger

Response

Successful Response

api_keystring required
messagestring

Changes

No recorded changes to this endpoint across all 1 revision of this API.