Mail: Mailboxes
List mailboxes
Retrieve a paginated list of mailboxes belonging to a mail order.
Use this endpoint to monitor mailboxes of your mail service, including their status, enabled protocols, attached resource counts, and periodically synced usage numbers (usage may lag behind live values).
get/api/mail/v1/orders/{orderId}/mailboxes
Path parameters
orderIdstring required
Example:OR1a2b3c4d5e6f7g
Order resource ID
Query parameters
searchstring nullable
Example:info
Filter mailboxes whose email address contains the given string
sort'address' | '-address' nullable
Example:address
Sort mailboxes by field. Prefix with - for descending order.
pageinteger
Example:1
Page number
per_pageinteger
Example:25
Number of items per page
Response
Success response
Example response
{
"data": [
{
"id": "AC1a2b3c4d5e6f7g",
"address": "info@example.com",
"status": "active",
"status_reason": "abuse",
"protocols": {
"is_imap_enabled": true,
"is_pop3_enabled": true,
"is_smtp_in_enabled": true,
"is_smtp_out_enabled": true
},
"counts": {
"forwarders": 2,
"aliases": 1
},
"usage": {
"storage_used": 512000,
"storage_quota": 10485760,
"messages_used": 1240,
"messages_quota": 50000,
"synced_at": "2026-07-22T08:12:00Z"
},
"created_at": "2025-03-01T10:00:00Z",
"updated_at": "2026-07-20T14:30:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}