api-keys

GET /v1/api-keys

List the organization's API keys.

همه نقاط پایانی api-keys

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز apikeys.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک پارامتر پرس‌وجو می‌پذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجاره‌ای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Lists the non-revoked API keys the caller can manage. Only key **metadata** is returned — never the secret or its hash (CLAUDE.md §2.4). Requires `apikeys.manage`.

پارامترها

نامنوعالزامیچیست
cursor (query)stringخیرOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerخیرMaximum items to return (page size).
org_id (query)UuidخیرRestrict to one organization in scope (default — every org you manage keys in).

پاسخ

نامنوعالزامیچیست
dataApiKey[]بله
pagePageMetaبله

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 422 · 429