List mailboxes
mail_listMailboxesV1Lists mailboxes for a mail order with pagination, search, and sorting. Use it to monitor mailbox status, enabled protocols, resource counts, and synced usage.
Instructions
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).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number | |
| sort | No | Sort mailboxes by field. Prefix with `-` for descending order. | |
| search | No | Filter mailboxes whose email address contains the given string | |
| orderId | Yes | Order resource ID | |
| per_page | No | Number of items per page |