v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
Mail: Catchalls

List catch-alls

Retrieve a paginated list of catch-alls across all mailboxes of a mail order.

get/api/mail/v1/orders/{orderId}/catchalls

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": "CA1a2b3c4d5e6f7g",
      "mailbox": {
        "id": "AC1a2b3c4d5e6f7g",
        "address": "user@example.com"
      },
      "domain": "example.com",
      "is_active": true,
      "is_confirmed": true,
      "created_at": "2026-07-27T12:00:00Z",
      "updated_at": "2026-07-27T12:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}