v171

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0726249111.7 MB
API keys

Retrieve an API key

Retrieves the metadata for an existing API key by its unique identifier. The raw secret is never returned — only token_prefix, permission_mode, project_scope, and lifecycle fields.

get/v2/api-keys/{api_key_id}

Path parameters

api_key_idstring required

API key id to retrieve (e.g. 01H...).

Query parameters

include_budgetboolean

When true, embed the api-key-scoped budget (config and limits only, no live usage) on the returned record.

Response

API key retrieved successfully.

idstring required
namestring required
workspace_idstring required
tokenstring required

Raw on create/retrieve and masked in list responses.

activeboolean
is_legacyboolean
sourcestring
budgetobject
expirationstring date-time
projectsstring[]
created_by_idstring nullable
updated_by_idstring nullable
createdstring date-time
updatedstring date-time
consumptionnumber
token_consumptionnumber
requests_per_minute_consumptionnumber
ownerobject
project_scopeobject
permission_modestring
accessobject
token_prefixstring
statusstring
constraintsobject
mcp_accessobject
legacy_token_familystring
legacy_key_idstring
last_used_atstring date-time