Skip to main content
GET
List API keys

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20

Maximum number of results to return

Required range: x <= 100
offset
integer
default:0

Number of results to skip

query
string

Case-insensitive substring match against API key name, creator, and project. API key identifiers and masked keys match by exact value or prefix.

name
string

Exact-match filter on API key name using the database collation. In production, matching is case- and accent-insensitive. Names are not required to be unique, so multiple keys may match. When status=all or include_deleted=true is set, soft-deleted keys with the same name may also match.

sort_by
enum<string>
default:created_at

Field to sort API keys by. Keys with no expiry or no recorded use sort last for expires_at and last_used_at in either direction.

Available options:
created_at,
name,
expires_at,
last_used_at
sort_direction
enum<string>
default:desc

Sort direction for API keys.

Available options:
asc,
desc
status
enum<string>
default:active

Filter API keys by status. "active" returns keys that are neither deleted nor expired (default), "expired" returns keys that are not deleted and whose expiry has passed, "deleted" returns only soft-deleted keys, "all" returns every key.

Available options:
active,
expired,
deleted,
all
service_account_id
string

Return only keys that belong to this service account.

principal_type
enum<string>

Return only keys that act as a user, or only keys that act as a service account.

Available options:
user,
service_account
created_by
string

Return only keys created by this user ID. This is the same person the key's created_by field describes.

project_id
string

Return only keys scoped to this project ID. The value "org" returns keys that are not scoped to a project.

include_deleted
boolean
default:false

Deprecated: use status=all instead. When true, include deleted (soft-deleted) API keys in the results for audit purposes.

Response

List of API keys

created_at
string<date-time>
required

When the API key was created

created_by
object | null
required

Human audit creator, or null after creator deletion. Not the service credential's principal.

deleted_at
string<date-time> | null
required

When the API key was deleted (soft-deleted). Null for keys that have not been deleted.

expires_at
string<date-time> | null
required

When the API key expires

id
string
required

Unique API key identifier

Example:

"ckv9w8q2f000001l5r3j7k9m4"

last_used_at
string<date-time> | null
required

When the API key last authenticated a request, accurate to within about 20 minutes. Null if the key has not been used since last-use tracking began.

masked_key
string
required

Masked version of the API key

Example:

"sk_1234...abcd"

name
string
required

Label for the API key. API keys are not addressable by name; use the ID or key identifier for stable references.

Example:

"production"

project_id
string | null
required

Project identifier for project-scoped API keys. Null means org-wide.

Example:

"proj_abc123"

project_name
string | null
required

Project name for project-scoped API keys. Null means the key is org-wide or the project name is unavailable.

Example:

"Production"

policy
object | null

Permissions granted to a scoped API key. Absent for an ordinary key, which keeps unrestricted access within its organization or project.

principal
object
service_account_id
string

Organization-owned service principal, when linked.