GET /v1/mail/services
List the organization's email services.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires mail.view.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
cursor (query) | string | Nie | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | Nie | Maximum items to return (page size). |
org_id (query) | Uuid | Nie | 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 | Nie | 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 | Nie | 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 | Nie | 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 | Nie | As worker_id, for a cloud ComputeServer rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
data | MailService[] | Tak | — |
page | PageMeta | Tak | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 429