GET /v1/mail/services/{mailServiceId}/forwarders
The forwarders on this domain.
Authentication
Send an API key as a bearer token. The key must carry the mail.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/forwarders \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Read through to the mail backend (#662). **Filtered to this service's own domain** — the backend lists forwarders per *account*, and one account can hold several domains, so returning its whole set would show a customer another domain's routing. Requires `mail.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
mailServiceId (path) | Uuid | Yes | Email service ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | MailForwarder[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503