Skip to main content
GET
List API keys

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Query Parameters

organizationId
string

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

Minimum string length: 1
websiteId
string

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.

Minimum string length: 1
revoked
enum<string>
default:exclude
Available options:
exclude,
only
cursor
string
limit
integer
default:20
Required range: 1 <= x <= 100

Response

One page of API keys, newest first.

items
object[]
required
nextCursor
string | null
required

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