List API keys

GET 
/v2/api_keys

Lists the API keys the caller can access. The response shows the corpora each key can access and with what permissions.

Callers with the corpus_administrator, administrator, or owner role list every API key in the account. Users holding only other roles must set api_key_role to personal and receive only their own personal key; machine credentials — API keys, app clients, and service accounts — without one of those three roles cannot list keys at all.

Request

Responses

200

The response includes an api_keys array with the API keys, and a metadata field with the pagination key.

400

API key list request was malformed.

403

The caller's roles do not allow this listing. Users that hold none of the corpus_administrator, administrator, or owner roles may only request their own personal keys with api_key_role set to personal; machine credentials without one of those three roles are refused regardless.