hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
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/sites/{siteId}/mail-log \
-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
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.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
period (query) | string<hourly, daily, weekly, monthly> | Nee | How far back to look, in the vendor's own four buckets. |
direction (query) | string<incoming, outgoing> | Nee | ⛔ 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 | Nee | Free-text match on sender, recipient or subject. |
page (query) | integer | Nee | — |
page_size (query) | integer | Nee | — |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
data | SiteMailLogEntry[] | Ja | — |
total | integer | Ja | — |
page | integer | Ja | — |
page_size | integer | Ja | — |
has_more | boolean | Ja | The vendor's own flag, not arithmetic on `total`. |
period | string | Ja | — |
direction | string | Ja | — |
periods | string[] | Ja | — |
directions | string[] | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429 · 503