api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Усі кінцеві точки api-keys

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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

Параметри

НазваТипОбов'язковеЩо це таке
apiKeyId (path)UuidТакThe API key's id.

Відповідь

НазваТипОбов'язковеЩо це таке
idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringТак
prefixstringТакThe key's public lookup id (the middle segment of the token).
scopesstring[]ТакThe RBAC permission keys this key may exercise.
sandboxbooleanТакA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectНіWhen the key last authenticated a request; null if never used.
revoked_atobjectНіAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringТак

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429