Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie mail.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires `mail.view`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
cursor (query) | string | Nee | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Nee | Maximum items to return (page size). |
org_id (query) | Uuid | Nee | 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 n… |
fqdn (query) | string | Nee | 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 pa… |
site_id (query) | string | Nee | 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 ou… |
worker_id (query) | string | Nee | 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 —… |
compute_server_id (query) | string | Nee | As `worker_id`, for a cloud `ComputeServer` rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
data | MailService[] | Ja | — |
page | PageMeta | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 429