Scopes attached to the calling key

Search Documentation

Search across all developer documentation

meta

Scopes attached to the calling key

GET /v1/_scopes
Auth required

Returns the scopes attached to the calling API key plus the key's identity (UUID, prefix, and environment live/test). Use this to verify a key authenticates correctly before issuing real traffic, and to confirm a recent scope change has taken effect. Any valid key may call this endpoint — no specific scope is required. Scope changes can take up to a few minutes to be reflected here.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 Scopes resolved from the cached API key application/json
key_id string<uuid> required
prefix string required
environment string enum required

One of: live, test

scopes array<string> required
401 Missing, malformed, or unknown API key application/problem+json
429 Per-org rate limit exceeded application/problem+json