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
| Field | Type | Description |
|---|---|---|
id | stringrequired | Public ID of the key (the 12 characters inside the key). |
name | stringrequired | The name given to the key when it was created. |
scopes | string[]required | Scopes of the key. |
expires_ | string (date-time)required | The 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_invalid401:unauthorized403:insufficient_scope,forbidden,module_disabled,trial_ended,key_suspended404:not_found429:rate_limited500:internal_error503:timeout