List workspace API key metadata

Returns retained key metadata across this workspace with SQL cursor pagination, including workspace-managed and user-owned keys of all scopes and retained deactivated keys. Credentials and permission payloads are excluded. Stack/member/user identity filters select stored response references, not effective access. Null or unavailable references never match these filters, including negative comparisons. Identity arrays must be nonempty; these fields are not sortable. GET /v2/api-key separately describes the calling key and its current effective permissions. Requires workspace-level API access view permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
object

Filters and sorts the list: URL-encoded JSON of the schema WorkspaceApiKeyFilter. where holds exactly one _and or _or with an array of clauses; a clause is another _and/_or or a field with exactly one operator. sort lists fields with + (ascending) or - (descending). An unsupported field, operator or value answers 400 invalid_filter with a pointer into the filter.

FieldTypeOperatorsSort
workspace_api_key[created_at]timestamp_eq _lt _gt _lte _gte _within _null _nnullyes
workspace_api_key[deactivation_reason]EXPIRATION_DATE | WORKSPACE_USER_REMOVED | STACK_DELETED | MANUAL_REVOCATION | SELF_SERVICE_DISABLED_eq _ne _in _nin–
workspace_api_key[description]text_eq _ne _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblank–
workspace_api_key[id]id_eq _ne _in _nin–
workspace_api_key[is_deactivated]boolean_true _false–
workspace_api_key[management_mode]WORKSPACE_MANAGED | USER_OWNED_eq _ne _in _nin–
workspace_api_key[member_id]id_eq _ne _in _nin–
workspace_api_key[name]text_eq _ne _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblankyes
workspace_api_key[scope]WORKSPACE | STACK | USER_eq _ne _in _nin–
workspace_api_key[stack_id]id_eq _ne _in _nin–
workspace_api_key[updated_at]timestamp_eq _lt _gt _lte _gte _within _null _nnullyes
workspace_api_key[user_id]id_eq _ne _in _nin–
string

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

int32
1 to 100
Defaults to 20

Maximum number of items to return per page (1-100).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json