Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar mail.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires `mail.view`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
cursor (query) | string | Hayır | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Hayır | Maximum items to return (page size). |
org_id (query) | Uuid | Hayır | 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 | Hayır | 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 | Hayır | 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 | Hayır | 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 | Hayır | As `worker_id`, for a cloud `ComputeServer` rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
data | MailService[] | Evet | — |
page | PageMeta | Evet | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 429