Skip to content

List API keys

GET
/v1/api-keys
curl --request GET \
--url http://localhost:8080/v1/api-keys

Returns the summary of every API key (id, name, prefix, scopes, created and revoked timestamps); the secret is never returned. Pass includeRevoked=true to include revoked keys. Administrators only.

includeRevoked
boolean

OK

Media typeapplication/json
Array<object>
object
id
required
string format: uuid
name
required
string
keyPrefix
required
string
scopes
required
Array<string>
createdAt
required
string format: date-time
revokedAt
required
null | string format: date-time
Examplegenerated
[
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"keyPrefix": "example",
"scopes": [
"example"
],
"createdAt": "2026-04-15T12:00:00Z",
"revokedAt": "2026-04-15T12:00:00Z"
}
]