GET /v1/mail/services
List the organization's email services.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires mail.view.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
cursor (query) | string | Nem | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | Nem | Maximum items to return (page size). |
org_id (query) | Uuid | Nem | 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 | Nem | 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 | Nem | 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 | Nem | 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 | Nem | As worker_id, for a cloud ComputeServer rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
data | MailService[] | Igen | — |
page | PageMeta | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 429