Mail: Aliases
List aliases
Retrieve a paginated list of aliases across all mailboxes of a mail order.
get/api/mail/v1/orders/{orderId}/aliases
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": "AA1a2b3c4d5e6f7g",
"address": "info@example.com",
"mailbox": {
"id": "AC1a2b3c4d5e6f7g",
"address": "john@example.com"
},
"is_active": true,
"created_at": "2026-07-27T12:00:00Z",
"updated_at": "2026-07-27T12:00:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}