Clerk API (unofficial showcase)
GET/api_keys

List API keys for a subject

Lists API keys associated with a specified subject. Use include_invalid to control whether invalid keys are included, and use query to filter the results. Use limit and offset to paginate the results.

6 parameters
typestringoptional
The API key type to list. Must contain at least 3 characters; defaults to `api_key` when omitted.
Default:api_key
subjectstringrequired
The subject identifier whose API keys to list. Must use the `user_`, `org_`, `mch_`, or `scim_` prefix followed by 27 word characters.
include_invalidstringoptional
Whether to include invalid API keys. Accepts `true` or `false`; defaults to `false` when omitted.
Allowed:truefalseDefault:false
limitnumberoptional
The maximum number of API keys to return. Must be between 1 and 100; defaults to 10 when omitted.
Default:10
offsetnumberoptional
The number of API keys to skip before returning results. Must be 0 or greater; defaults to 0 when omitted.
Default:0
querystringoptional
A query string to filter the API keys.

3 status codes
200Returns an object containing the API key objects in `data` and the matching result count in `total_count`.
dataarray<object>required
total_countnumberrequired
400Returned when query parameters are invalid.
errorsarray<object>required
404Returned when the requested subject or resource is not found.
errorsarray<object>required

Error handling

A 400 indicates invalid query data; a 404 indicates the requested subject or resource was not found. The subject query parameter must match the user_, org_, mch_, or scim_ identifier format followed by 27 word characters; limit must be between 1 and 100, and offset must be 0 or greater.