Clerk API (unofficial showcase)
GET/api_keys/{apiKeyID}

Get an API key by ID

Retrieves an API key by its identifier. Supply the key ID in the path using either the ak_ or api_key_ prefix followed by 32 hexadecimal characters. The response contains the key's configuration and status.

1 parameter
apiKeyIDstringrequired
The API key identifier, using the `ak_` or `api_key_` prefix followed by 32 hexadecimal characters.

3 status codes
200Returns the API key object, including its identifier, subject, name, scopes, status, and timestamps.
objectstringrequired
Allowed:api_key
idstringrequired
typestringrequired
subjectstringrequired
namestringrequired
descriptionstringoptional
claimsunknownrequired
scopesarray<string>required
revokedbooleanrequired
revocation_reasonstringrequired
expiredbooleanrequired
expirationnumberrequired
The timestamp for when the API key will expire, in milliseconds
created_bystringrequired
last_used_atnumberrequired
The timestamp for when the API key was last used, in milliseconds
created_atnumberrequired
The timestamp for when the API key was created, in milliseconds
updated_atnumberrequired
The timestamp for when the API key was last updated, in milliseconds
400Returned when the request is invalid.
errorsarray<object>required
404Returned when the API key is not found.
errorsarray<object>required

Error handling

A 400 indicates an invalid request; a 404 indicates the API key was not found. The apiKeyID path parameter must match either the ak_ or api_key_ prefix followed by 32 hexadecimal characters.