Vee3

List Clerk API keys

List API keys for a subject in a connected Clerk application.

← All Clerk endpoints · Capability overview

GET/v1/clerk/api-keys

https://api.vee3.io/v1/clerk/api-keys

5 tokens

List API keys for a subject in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.list_api_keys
Parameters7 fields
clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

subjectstringRequired

Subject to list API keys for (user_... or org_...).

key_typestringOptional

Filter by API key type (typically "api_key").

include_invalidbooleanOptional

When true, include revoked or expired API keys.

limitintegerOptional

Maximum number of API keys to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of API keys to skip before returning results.

Default: 0 · min 0

querystringOptional

Search query to filter API keys by name.

Response18 fields
api_keysarrayitems
16 fields

API keys matching the request.

idstring

Clerk API key id (ak_...).

namestring

Human-readable API key name.

subjectstring

Subject the API key is scoped to (user_... or org_...).

key_typestring

API key type (typically "api_key").

descriptionstring

Optional description for the API key.

claimsobject
1 field

Custom claims embedded in tokens minted from this API key.

claim_keystring

A key in the custom claims object.

scopesarrayitems
1 field

Permission scopes granted to this API key.

itemstring

A single scope string.

created_bystring

User id that created the API key, when set.

created_atinteger

Unix timestamp in milliseconds when the API key was created.

updated_atinteger

Unix timestamp in milliseconds when the API key was last updated.

expirationinteger

Unix timestamp in milliseconds when the API key expires, if set.

revokedboolean

Whether the API key has been revoked.

revocation_reasonstring

Reason recorded when the API key was revoked.

secretstring

API key secret value. Treat as high-privilege — do not log.

total_countinteger

Total number of API keys matching the filters.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required