Skip to content

List API keys​

GET
/v1/api-keys

Returns the signed-in user's API keys — never the secret or its hash, just enough to recognize each one (name, prefix, scopes, and usage dates). Revoked keys are included too, for an audit view.

Authorizations​

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Responses​

OK

application/json

When the key was created.

Format"date-time"

When the key stops working, or null if it never expires.

Format"date-time"

Stable identifier for this key.

Format"uuid"

When the key was last used to authenticate, or null if
it has never been used.

Format"date-time"

The caller-supplied label for this key.

The key's non-secret prefix, safe to display for recognition.

When the key was revoked, or null if it's still active.

Format"date-time"

The permissions this key grants.

Playground​

Server
Authorization

Samples​

Powered by VitePress OpenAPI