mail

GET /v1/mail/services/{mailServiceId}

Get one email service.

Tüm mail uç noktaları

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.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırı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/{mailServiceId} \
  -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

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

Parametreler

AdTürZorunluNe olduğu
mailServiceId (path)UuidEvetEmail service ID (UUIDv7).

Yanıt

AdTürZorunluNe olduğu
idUuidEvetUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringEvetThe domain the mailboxes are on.
provider_configMailProviderConfig | nullHayırThe `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 | nullHayırThe 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_provisioningMailboxProvisioningEvetWhether **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_onlybooleanEvet**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 | nullHayırThe registered domain this serves, when we hold the registration.
statusMailServiceStatusEvetA mail service's lifecycle state.
providerMailProviderEvetWhich 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_mbintegerEvetSize of each mailbox in MB, captured when the service was created.
mailbox_limitintegerEvetMailboxes 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_usedintegerEvetHow many mailboxes currently consume the allowance.
dns_applied_atobjectHayırWhen 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_atstringEvet

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 429