Skip to content

List Api Keys

GET
/api-keys

List every API key in the caller’s own org (never the secret).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
keys
required
Array<object>

One API key’s metadata (never the secret).

object
api_key_id
required
string
created_at
Any of:
integer
created_by
Any of:
string
daily_credit_cap
Any of:
integer
environment

Sandbox or live, derived from mode (additive; a test key reads live).

string
default: live
expires_at
Any of:
integer
ip_allowlist

CIDRs this key is restricted to. Empty = unrestricted.

Array<string>
is_agency

Whether this key is agency-scoped. Informational — this door cannot mint one.

boolean
is_legacy_unrestricted

True for a key minted before scopes existed. An empty scope list means unrestricted, not ‘no access’.

boolean
key_prefix
Any of:
string
last_used_at
Any of:
integer
mode
string
default: live
monthly_credit_cap
Any of:
integer
name
required
string
scopes
Array<string>
spend_alert_threshold_pct
Any of:
integer
total
required
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string