Skip to content

List API keys

GET
/v1/api-keys
curl --request GET \
--url 'https://example.com/v1/api-keys?limit=50' \
--header 'X-API-Key: <X-API-Key>' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

limit
integer
default: 50 <= 250

Maximum number of items to return.

cursor
string

Opaque pagination cursor from a previous response. Omit for the first page.

identity_provider_id
string format: uuid

Filter API keys by identity provider ID

OK

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
name
required
string
scopes
required
Array<string>
created_by

User ID or email of the key creator.

string
nullable
last_used_at
string format: date-time
nullable
expires_at
string format: date-time
nullable
revoked_at

When the key was revoked. Null if active.

string format: date-time
nullable
revoked_by

User who revoked the key.

string
nullable
created_at
required
string format: date-time
identity_provider_id

Links this API key to a specific identity provider (used for SCIM tokens).

string format: uuid
nullable
next_cursor
string
nullable
has_more
required
boolean
Example generated
{
"data": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"scopes": [
"example"
],
"created_by": "example",
"last_used_at": "2026-04-15T12:00:00Z",
"expires_at": "2026-04-15T12:00:00Z",
"revoked_at": "2026-04-15T12:00:00Z",
"revoked_by": "example",
"created_at": "2026-04-15T12:00:00Z",
"identity_provider_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
],
"next_cursor": "example",
"has_more": true
}

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}

Forbidden

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}