Skip to main content
GET
Introspect the credential

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Response

200 response

The authenticated credential: workspace binding, kind, and effective scopes.

organizationId
string
required

The workspace this credential is bound to.

Example:

"org_2abc..."

authKind
enum<string>
required

How the request authenticated: api_key (REST v2 key — the only kind the public API serves today), session (UI cookie), or direct (the internal CLI's in-process transport).

Available options:
api_key,
session,
direct
Example:

"api_key"

apiKeyId
string | null
required

Clerk API key id (ak_...) when authenticated with a key, else null.

Example:

"ak_2abc..."

scopes
enum<string>[]
required

Effective scopes of the credential. Keys minted before scoping existed carry no explicit scopes and are enforced as read-only, so they report ["read"] here — exactly what the scope gate applies.

One API scope. read < write < admin (each implies the previous).

Available options:
read,
write,
admin
Example:
userId
string | null
required

User the request acts as (an API key acts as the user who minted it), when known.