mail

GET /v1/mail/services

List the organization's email services.

所有 mail 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 mail.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

您的组织 ID 应填在此处

此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。

您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

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

参数

名称类型必填内容简介
cursor (query)stringOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerMaximum items to return (page size).
org_id (query)UuidRestrict 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)stringReturn 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)stringReturn 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)stringReturn 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)stringAs `worker_id`, for a cloud `ComputeServer` rather than a fleet worker. The two are different machine kinds and are not interchangeable.

响应

名称类型必填内容简介
dataMailService[]
pagePageMeta

此端点可能返回的错误

401 · 403 · 429