List

List Keys

get

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

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

Authorizations

APIKeyHeaderAPIKeyHeaderAPIKeyHeaderAPIKeyHeaderAPIKeyHeader

Query parameters

pageinteger · min: 1 · default: 1optional

Page number

sizeinteger · min: 1 · max: 100 · default: 10optional

Page size

user_idany ofoptional

Filter keys by user ID

team_idany ofoptional

Filter keys by team ID

organization_idany ofoptional

Filter keys by organization ID

key_aliasany ofoptional

Filter keys by key alias

return_full_objectboolean · default: falseoptional

Return full key object

include_team_keysboolean · default: falseoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/key/list' \
  --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY'

200

422

200

{
  "keys": [
    "text"
  ],
  "total_count": 1,
  "current_page": 1,
  "total_pages": 1
}

Successful Response