v1

latestOpenAPI 3.1.02026-07-263580186.3 KB
API Keys

List API keys

List all API keys belonging to the authenticated user.

Each entry exposes its workspace scope via scopes. Every scope entry carries a scope_type:

  • workspace — the key is explicitly scoped to that workspace, with its own per-workspace permission (viewer, editor, or owner).
  • global — the key has no explicit scope rows and reaches every workspace you can access; scopes then lists those workspaces with your own current role on each (the effective access ceiling). A global key never mixes the two types.
get/api/v3/keys

Query parameters

is_expiredboolean
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

Paginated list of API keys belonging to the authenticated user.

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}
All 35 operations