mail

GET /v1/mail/services/{mailServiceId}/mailboxes

List a domain's mailboxes.

सभी mail एंडपॉइंट्स

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास mail.view अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

The mailboxes on this email service, cursor-paginated. Served from our own records rather than from the backend, so a listing never puts an external call in a hot path (CLAUDE.md §2.16). Requires `mail.view`.

पैरामीटर

नामप्रकारआवश्यकयह क्या है
mailServiceId (path)UuidहाँEmail service ID (UUIDv7).
cursor (query)stringनहींOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerनहींMaximum items to return (page size).

प्रतिक्रिया

नामप्रकारआवश्यकयह क्या है
dataMailbox[]हाँ
pagePageMetaहाँ

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 404 · 429