प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग mail.view अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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

लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्

विवरणहरू

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

प्यारामिटरहरू

नामप्रकारआवश्यकयो के हो
mailServiceId (path)Uuidहुन्छEmail service ID (UUIDv7).

प्रतिक्रिया

नामप्रकारआवश्यकयो के हो
idUuidहुन्छUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringहुन्छThe domain the mailboxes are on.
provider_configMailProviderConfig | nullहैनThe 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 | nullहैनThe 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_provisioningMailboxProvisioningहुन्छWhether 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…
domain_idUuid | nullहैनThe registered domain this serves, when we hold the registration.
statusMailServiceStatusहुन्छA mail service's lifecycle state.
providerMailProviderहुन्छWhich 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_mbintegerहुन्छSize of each mailbox in MB, captured when the service was created.
mailbox_limitintegerहुन्छMailboxes 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_usedintegerहुन्छHow many mailboxes currently consume the allowance.
dns_applied_atobjectहैनWhen 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