api
api_keys
Create an API Key
post/api/keys
Request body
namestring required
An internal name to identify the API key.
orgIdstring
The organization ID for which to create the API key.
expiresAtstring date-time
Optional expiry time (strictly future, at most one year); omit for keys that do not auto-expire.
Response
Created
_idstring required
The ID of the API key.
activeboolean
Whether the API key can be used to authenticate against the API.
namestring required
An internal name to identify the API key.
sellerIdstring
The ID of the seller that owns the API key.
orgIdstring
The ID of the organisation that owns the API key.
keystring required
The secret key to be used to authenticate against the API.
createdAtstring date-time required
An ISO Timestamp indicating when the API Key was created.
updatedAtstring date-time required
An ISO Timestamp indicating when the API Key was last updated.
expiresAtstring date-time nullable
Optional ISO instant after which the key no longer authenticates; omit or null for no automatic expiry.
Example response
{
"key": "key_somerandomcombinationofnumbersandletters"
}