hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-log \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
period (query) | string<hourly, daily, weekly, monthly> | Não | How far back to look, in the vendor's own four buckets. |
direction (query) | string<incoming, outgoing> | Não | ⛔ 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 | Não | Free-text match on sender, recipient or subject. |
page (query) | integer | Não | — |
page_size (query) | integer | Não | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
data | SiteMailLogEntry[] | Sim | — |
total | integer | Sim | — |
page | integer | Sim | — |
page_size | integer | Sim | — |
has_more | boolean | Sim | The vendor's own flag, not arithmetic on `total`. |
period | string | Sim | — |
direction | string | Sim | — |
periods | string[] | Sim | — |
directions | string[] | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429 · 503