mail

GET /v1/mail/services/{mailServiceId}

Get one email service.

Wszystkie punkty końcowe mail

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

NazwaTypWymaganeCo to jest
mailServiceId (path)UuidTakEmail service ID (UUIDv7).

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringTakThe domain the mailboxes are on.
provider_configMailProviderConfig | nullNieThe 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…
siteMailServiceSite | nullNieThe 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_provisioningMailboxProvisioningTakWhether 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_onlybooleanTakThis 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…
domain_idUuid | nullNieThe registered domain this serves, when we hold the registration.
statusMailServiceStatusTakA mail service's lifecycle state.
providerMailProviderTakWhich 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,…
mailbox_quota_mbintegerTakSize of each mailbox in MB, captured when the service was created.
mailbox_limitintegerTakMailboxes 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…
mailboxes_usedintegerTakHow many mailboxes currently consume the allowance.
dns_applied_atobjectNieWhen 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_atstringTak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429