Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso mail.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint acepta org_id como parámetro de consulta. Omítelo y la llamada abarcará todo tu subárbol de inquilinos; envíalo para acotar la llamada a una sola organización.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires `mail.view`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
cursor (query) | string | No | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | No | Maximum items to return (page size). |
org_id (query) | Uuid | No | 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 | No | 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 | No | 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 | No | 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 | No | As `worker_id`, for a cloud `ComputeServer` rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
data | MailService[] | Sí | — |
page | PageMeta | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 429