Sign in
OpenAPI 3.1.02026-08-226994571.1 MB

1e929292ddd5

key management

List Keys

List all keys for a given user / team / organization.

Parameters: expand: Optional[List[str]] - Expand related objects (e.g. 'user' to include user information) status: Optional[str] - Filter by status. Currently supports "deleted" to query deleted keys.

Returns: { "keys": List[str] or List[UserAPIKeyAuth], "total_count": int, "current_page": int, "total_pages": int, }

When expand includes "user", each key object will include a "user" field with the associated user object. Note: When expand=user is specified, full key objects are returned regardless of the return_full_object parameter.

get/key/list

Query parameters

pageinteger

Page number

Page number

sizeinteger

Page size

Page size

user_idstring nullable

Filter keys by user ID

Filter keys by user ID

team_idstring nullable

Filter keys by team ID

Filter keys by team ID

organization_idstring nullable

Filter keys by organization ID

Filter keys by organization ID

key_hashstring nullable

Filter keys by key hash

Filter keys by key hash

key_aliasstring nullable

Filter keys by key alias

Filter keys by key alias

return_full_objectboolean

Return full key object

Return full key object

include_team_keysboolean

Include all keys for teams that user is an admin of.

Include all keys for teams that user is an admin of.

include_created_by_keysboolean

Include keys created by the user

Include keys created by the user

sort_bystring nullable

Column to sort by (e.g. 'user_id', 'created_at', 'spend')

Column to sort by (e.g. 'user_id', 'created_at', 'spend')

sort_orderstring

Sort order ('asc' or 'desc')

Sort order ('asc' or 'desc')

expandstring[] nullable

Expand related objects (e.g. 'user')

Expand related objects (e.g. 'user')

statusstring nullable

Filter by status (e.g. 'deleted')

Filter by status (e.g. 'deleted')

project_idstring nullable

Filter keys by project ID

Filter keys by project ID

access_group_idstring nullable

Filter keys by access group ID

Filter keys by access group ID

Response

Successful Response

total_countinteger nullable
current_pageinteger nullable
total_pagesinteger nullable