Sign in
Keys

List API Keys

Returns a list of all API keys belonging to the authenticated user's workspace.

Requirements:

  • Authentication required via admin API key

Key Features:

  • View all API keys with their aliases and creation dates
  • Optionally expand to include creator information
  • Paginated results for workspaces with many keys

Expansion Options:

  • expand=creator_info: Include creator_nickname and creator_email for each key

Common Use Cases:

  • Audit existing API keys
  • Find keys by alias
  • Monitor key creation activity
  • Build key management interfaces
get/keys

Query parameters

limitinteger

Maximum number of items to return. Actual maximum depends on query type and expansion parameters.

Example:50

Maximum number of items to return. Actual maximum depends on query type and expansion parameters.

cursorstring

Pagination cursor from previous response. Encodes the page number.

Example:Mg==

Pagination cursor from previous response. Encodes the page number.

string
OR
string[]

Fields to expand in the response. Available: creator_info (includes creator_nickname and creator_email)

Response

Successfully retrieved API keys

next_cursorstring nullable required

Cursor for the next page of results, null if no more pages

has_moreboolean required

Boolean indicating if more results are available (convenience field derived from next_cursor)

Example response

{
  "keys": [
    {
      "key_id": "abc123def456",
      "alias": "Production Key",
      "scope": "API",
      "created_at": "2025-01-15T12:00:00Z",
      "creator_nickname": "developer",
      "creator_email": "developer@example.com"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.