Sign in
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

Changes

Changed in 16 of the 253 revisions of this API.710

  • 6f132f005b2a1See the full diff
    • ●

      removed the optional property api_key/allOf[ApiKey]/mcp_access from the response with the 200 status

      response-optional-property-removed

    This revision also has 97 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3128fb112d661See the full diff
    • ○

      added the optional property api_key/allOf[ApiKey]/mcp_access to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d1ae9e3491f71See the full diff
    • ●

      removed the optional property api_key/allOf[ApiKey]/mcp_access from the response with the 200 status

      response-optional-property-removed

    This revision also has 95 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 81dd5e8c8ae51See the full diff
    • ○

      added the optional property api_key/allOf[ApiKey]/mcp_access to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c165184caee51See the full diff
    • ●

      removed the optional property api_key/allOf[ApiKey]/mcp_access from the response with the 200 status

      response-optional-property-removed

    This revision also has 158 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 81f63764455c1See the full diff
    • ○

      added the optional property api_key/allOf[ApiKey]/mcp_access to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3989ac7bfc9d1See the full diff
    • ●

      removed the optional property api_key/allOf[ApiKey]/mcp_access from the response with the 200 status

      response-optional-property-removed

    This revision also has 158 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a16b5d9f224e1See the full diff
    • ○

      added the optional property api_key/allOf[ApiKey]/mcp_access to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 40c117ce8db11See the full diff
    • ●

      removed the optional property api_key/allOf[ApiKey]/mcp_access from the response with the 200 status

      response-optional-property-removed

    This revision also has 156 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0ba8132d0ed01See the full diff
    • ○

      added the optional property api_key/allOf[ApiKey]/mcp_access to the response with the 200 status

      response-optional-property-added

Of the 253 revisions, 71 have no diff computed.