v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
API Keys

List API keys

List API keys. Returns metadata for each key (id, name, description, key_type, status, redacted_key, created_at, expires_at, created_by_user_id). The raw key secret is never returned after creation.

Results can be filtered by key type, status, space, and creator. Responses are paginated; use limit and cursor and the response pagination.next_cursor for subsequent pages.

Service keys (key_type=SERVICE): Provide space_id to return all service keys for that space. When key_type is omitted alongside space_id, service keys are returned implicitly. Requires the SERVICE_KEY_READ permission in the space (or account/space admin). Optionally combine with user_id to filter service keys by their creator — available to any caller with space access (not admin-gated).

User keys (key_type=USER): Returned by default (no space_id). Provide user_id to view keys belonging to a specific user — account admins only; non-admins receive 403.

<Note>This endpoint is in beta, read more here.</Note>

get/v2/api-keys

Query parameters

key_type'USER' | 'SERVICE'

Type of the API key.

  • USER - Personal key that authenticates as the creating user.
  • SERVICE - Key that authenticates as a service account with explicitly granted access.

Filter by API key type.

  • USER - Key associated with a specific user.
  • SERVICE - Key associated with a bot user for service authentication.
status'ACTIVE' | 'REVOKED'

Current status of the API key.

  • ACTIVE - The key is valid for use.
  • REVOKED - The key has been revoked and is no longer valid.

Filter by API key status.

  • ACTIVE - Only return keys that are valid for use.
  • REVOKED - Only return keys that have been revoked.

When not specified, defaults to ACTIVE.

space_idstring

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

Filter search results to a particular space ID

user_idstring

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

Filter results by user (base64 global user ID). When provided, only records associated with this user are returned. Access requirements vary by endpoint — some endpoints restrict this filter to account admins.

limitinteger

Maximum items to return

cursorstring

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

Response

Returns a list of API keys matching the request filters. The raw key secret is never returned.