Sign in
latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api
api_keys

Get or Create a Default API Key

post/api/keys/default

Request body

sellerIdstring required

The seller ID to get or create the API key for.

Response

OK

_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"
}