mail

GET /v1/mail/services/{mailServiceId}

Get one email service.

所有 mail 端点

身份验证

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

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

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

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

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

详细信息

One email service in the caller's scope. Requires `mail.view`.

参数

名称类型必填内容简介
mailServiceId (path)UuidEmail service ID (UUIDv7).

响应

名称类型必填内容简介
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringThe domain the mailboxes are on.
provider_configMailProviderConfig | nullThe `custom` provider's declared values, served back so the domain screen can show and edit what was declared. `null` on every other provider, whose values are documented and de…
siteMailServiceSite | nullThe site currently serving this domain, or `null` when no site does. **Derived from the hostname, never stored**: mail attaches to a domain and a domain outlives the site on it,…
mailbox_provisioningMailboxProvisioningWhether **we** pre-create a starter mailbox on this domain. `managed` — we make one when the domain is provisioned (the Footprint-Free/PBN line and our own fleet); `self_service…
mail_onlyboolean**This domain uses us for mail and nothing else** — an active mail service on a hostname no website of ours serves. Published as one server-side answer because more than one con…
domain_idUuid | nullThe registered domain this serves, when we hold the registration.
statusMailServiceStatusA mail service's lifecycle state.
providerMailProviderWhich provider serves a domain's mail. `custom` is **the reseller's own provider** (W40-MAIL, owner ruling 2026-09-06): a white-label reseller sells mail they buy elsewhere, dec…
mailbox_quota_mbintegerSize of each mailbox in MB, captured when the service was created.
mailbox_limitintegerMailboxes allowed on this domain; `-1` is uncapped. Captured when the service was created; a later downgrade is enforced against the live plan as well, so the number actually ap…
mailboxes_usedintegerHow many mailboxes currently consume the allowance.
dns_applied_atobjectWhen the mail DNS was last published. `null` means never — mailboxes that exist but receive nothing, which is the one state a customer must be told about.
created_atstring

此端点可能返回的错误

401 · 403 · 404 · 429