प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास mail.view अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
विवरण
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires `mail.view`.
पैरामीटर
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
cursor (query) | string | नहीं | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | नहीं | Maximum items to return (page size). |
org_id (query) | Uuid | नहीं | Restrict 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) | string | नहीं | Return 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) | string | नहीं | Return 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) | string | नहीं | Return 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) | string | नहीं | As `worker_id`, for a cloud `ComputeServer` rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
data | MailService[] | हाँ | — |
page | PageMeta | हाँ | — |
त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है
401 · 403 · 429