GET /v1/mail/services
List the organization's email services.
Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu mail.view; ključ bez nje se odbija s kodom 403, a ne 404.
Gdje dolazi ID vaše organizacije
Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.
ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires mail.view.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
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. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
data | MailService[] | Da | — |
page | PageMeta | Da | — |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 429