mail

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

List a domain's mailboxes.

すべての mail エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには mail.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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