api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Todos los endpoints de api-keys

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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

Parámetros

NombreTipoObligatorio¿Qué es esto?
apiKeyId (path)UuidThe API key's id.

Respuesta

NombreTipoObligatorio¿Qué es esto?
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestring
prefixstringThe key's public lookup id (the middle segment of the token).
scopesstring[]The RBAC permission keys this key may exercise.
sandboxbooleanA 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_atstring

Errores que este endpoint puede devolver

401 · 403 · 404 · 429