api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

All api-keys endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks apikeys.manage; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/api-keys/{apiKeyId} \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Returns one non-revoked key's metadata (never the secret). RBAC + RLS scoped.

Parameters

NameTypeRequiredWhat it is
apiKeyId (path)UuidYesThe API key's id.

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringYes—
prefixstringYesThe key's public lookup id (the middle segment of the token).
scopesstring[]YesThe RBAC permission keys this key may exercise.
sandboxbooleanYesA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectNoWhen the key last authenticated a request; null if never used.
revoked_atobjectNoAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringYes—

Errors this endpoint can return

401 · 403 · 404 · 429