Mail: Forwarders
List forwarders
Retrieve a paginated list of forwarders across all mailboxes of a mail order.
get/api/mail/v1/orders/{orderId}/forwarders
Path parameters
orderIdstring required
Example:OR1a2b3c4d5e6f7g
Order resource ID
Query parameters
pageinteger
Example:1
Page number
per_pageinteger
Example:25
Number of items per page
Response
Success response
Example response
{
"data": [
{
"id": "FW1a2b3c4d5e6f7g",
"mailbox": {
"id": "AC1a2b3c4d5e6f7g",
"address": "user@example.com"
},
"destination": "jane@example.org",
"is_keep_copy_enabled": true,
"is_active": true,
"is_confirmed": true,
"created_at": "2026-07-24T12:00:00Z",
"updated_at": "2026-07-24T12:00:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}