GET /v1/mail/services
List the organization's email services.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл mail.view; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires mail.view.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
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. Narrowing only — the value is intersected with what the caller may already read, so an organization outside their subtree filters to… |
fqdn (query) | string | Ні | Return only the service on this exact hostname (normalised: lowercased, trailing dot stripped). ⛔ A site surface must use this rather than searching the list. The list is… |
site_id (query) | string | Ні | Return only the mail services on the hostnames this site serves. Resolved through the site's domains, not through a stored column — mail attaches to a domain and a domain… |
worker_id (query) | string | Ні | Return only the mail services belonging to the sites on this fleet worker. Mail has no server of its own — it runs at the mail backend, not on the box serving the website — so… |
compute_server_id (query) | string | Ні | As worker_id, for a cloud ComputeServer rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
data | MailService[] | Так | — |
page | PageMeta | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 429