GET /v1/mail/services
List the organization's email services.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires mail.view.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
cursor (query) | string | Ne | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | Ne | Maximum items to return (page size). |
org_id (query) | Uuid | Ne | 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 | Ne | 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 | Ne | 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 | Ne | 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 | Ne | As worker_id, for a cloud ComputeServer rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
data | MailService[] | Ano | — |
page | PageMeta | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 429