Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.view; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/domains \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
The registered/connected domains in scope. Cursor-paginated, RLS-scoped. Requires `sites.view`.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
X-Zinn-Org (header) | string | Ні | **Which organisation this call acts for.** Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
cursor (query) | string | Ні | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Ні | Maximum items to return (page size). |
status (query) | DomainStatus | Ні | Filter by domain lifecycle status. |
org_id (query) | Uuid | Ні | Restrict to one organization in scope. |
tld (query) | string | Ні | Filter by TLD (e.g. `com`). |
site_id (query) | Uuid | Ні | Restrict to the domain backing one site — the link a site's DNS screen follows to reach the zone it should edit. Scoped by the same RLS filter as everything else here, so a site… |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
data | Domain[] | Так | — |
page | PageMeta | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 422 · 429