API keys

List API keys

Returns API keys newest first with keyset pagination and their full access configuration. Pass exactly one of organizationId (the full organization inventory) or websiteId (only keys whose access kind is websites with a direct grant on that website — organization-wide keys can also act on the website but appear only in the organization inventory). Revoked keys are excluded by default; pass revoked=only to list them instead. Page size defaults to 20 (maximum 100). Secrets are never returned — only metadata.

get/apiKeys

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/apiKeys
  • Auth: HTTP bearer

Query parameters

organizationIdstring

Organization whose full API key inventory to list. Provide either this or websiteId.

websiteIdstring

List only API keys with a direct grant on this website (access kind websites). Organization-wide keys can also act on the website but are not included; list those with organizationId. Provide either this or organizationId.

revoked'exclude' | 'only'
cursorstring
limitinteger

Response

One page of API keys, newest first.

nextCursorstring nullable required

Opaque cursor for the next page. Pass it as the cursor parameter on the next request. null when this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.