mail

GET /v1/mail/services

List the organization's email services.

Të gjitha pikat e skajshme mail

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen mail.view; një çelës pa të refuzohet me 403, jo 404.

Ku shkon id i organizatës suaj

Ky endpoint pranon org_id si parametër kërkimi. Lëreni bosh dhe thirrja do të mbulojë të gjithë nëndrurin tuaj të qiramarrjes; dërgojeni atë për ta ngushtuar thirrjen në një organizatë të vetme.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

curl -X GET https://api.zinndigital.com/v1/mail/services \
  -H "Authorization: Bearer zdk_live_…"

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires `mail.view`.

Parametrat

EmriLlojiKërkohetÇfarë është kjo
cursor (query)stringJoOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerJoMaximum items to return (page size).
org_id (query)UuidJoRestrict 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)stringJoReturn 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)stringJoReturn 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)stringJoReturn 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)stringJoAs `worker_id`, for a cloud `ComputeServer` rather than a fleet worker. The two are different machine kinds and are not interchangeable.

Përgjigja

EmriLlojiKërkohetÇfarë është kjo
dataMailService[]Po
pagePageMetaPo

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 429