hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-log \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
siteId (path) | Uuid | Так | Site ID (UUIDv7). |
period (query) | string<hourly, daily, weekly, monthly> | Ні | How far back to look, in the vendor's own four buckets. |
direction (query) | string<incoming, outgoing> | Ні | ⛔ 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 | Ні | Free-text match on sender, recipient or subject. |
page (query) | integer | Ні | — |
page_size (query) | integer | Ні | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
data | SiteMailLogEntry[] | Так | — |
total | integer | Так | — |
page | integer | Так | — |
page_size | integer | Так | — |
has_more | boolean | Так | The vendor's own flag, not arithmetic on total. |
period | string | Так | — |
direction | string | Так | — |
periods | string[] | Так | — |
directions | string[] | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429 · 503