hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
Autenticación
Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
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/sites/{siteId}/mail-log \
-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
Paginated by the vendor, so `has_more` is its own answer rather than arithmetic on `total`. An empty page for a site with no mail is a normal state, not a failure. ⛔ Requires **`sites.panel_access`**, not `sites.view` — unlike every other read on this panel. Sender, recipient and subject lines are the customer's correspondence, the same class of data as their files and their database, and `sites.panel_access` is the key that already gates both. A principal holding only `sites.view` gets a 404.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
siteId (path) | Uuid | Sí | Site ID (UUIDv7). |
period (query) | string<hourly, daily, weekly, monthly> | No | How far back to look, in the vendor's own four buckets. |
direction (query) | string<incoming, outgoing> | No | ⛔ One direction at a time — the vendor has no "both", so a client showing a combined view must make two calls and say which is which. |
search (query) | string | No | Free-text match on sender, recipient or subject. |
page (query) | integer | No | — |
page_size (query) | integer | No | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
data | SiteMailLogEntry[] | Sí | — |
total | integer | Sí | — |
page | integer | Sí | — |
page_size | integer | Sí | — |
has_more | boolean | Sí | The vendor's own flag, not arithmetic on `total`. |
period | string | Sí | — |
direction | string | Sí | — |
periods | string[] | Sí | — |
directions | string[] | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429 · 503