Skip to content

Key

Key endpoints: parameters, fields and example responses.

Developer documentation

Name, scopes and expiry of the key in use

GET /api/v1/key

Scope: No scope needed

Responses

200 Successful

key.get: Responses
FieldTypeDescription
idstringrequiredPublic ID of the key (the 12 characters inside the key).
namestringrequiredThe name given to the key when it was created.
scopesstring[]requiredScopes of the key.
expires_atstring (date-time)requiredThe moment the key expires (UTC).

Error codes

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout