List Inbound Routes

List a domain's inbound routes, paginated and sorted by priority.

GEThttps://api.maileroo.com/v1/domains/:domain_id/inbound-routes

List a domain's inbound routes. Results are paginated (10 per page) and sorted by priority.

Scope: domains.inbound_routing.read

Path Parameters

domain_idintegerrequired

The ID of the domain.

Query Parameters

searchstringoptional

Optional search term — matches description, recipient, header, or expression.

pageintegeroptional

Page number. Defaults to 1.

Response

itemsarrayoptional

Route objects. See the route object schema below.

pageintegeroptional

Current page.

total_pagesintegeroptional

Total number of pages.

Route object

Field	Type	Description
`id`	string	Route ID (read-only).
`user_id`	integer	Owning user ID (read-only).
`domain_id`	integer	Owning domain ID (read-only).
`domain_name`	string	Domain name (read-only).
`description`	string	3-255 chars.
`expression_type`	string	One of `catch_all`, `custom`, `match_header`, `match_recipient`.
`header_name`	string	Required when `expression_type=match_header`.
`header_content`	string	Required when `expression_type=match_header`.
`recipient`	string	Required when `expression_type=match_recipient`.
`custom_expression`	string	Required when `expression_type=custom` (expression syntax).
`regex_enabled`	boolean	Treat expression content as regex.
`forward_list`	string[]	Non-empty list of email addresses and/or callback URLs.
`dmarc_alignment`	boolean	Require DMARC alignment.
`require_spf`	boolean	Require SPF pass.
`require_dkim`	boolean	Require DKIM pass.
`skip_spam_check`	boolean	Skip spam filtering.
`stop`	boolean	Stop processing further routes when matched.
`priority`	integer	1 (highest) to 100 (lowest).
`created_at`	string	RFC3339 timestamp (read-only).

Sample Response

200 OK

{
  "data": {
    "items": [
      {
        "id": "66a1...",
        "domain_id": 123,
        "description": "Support inbox",
        "expression_type": "match_recipient",
        "recipient": "[email protected]",
        "forward_list": ["[email protected]"],
        "priority": 10,
        "stop": true
      }
    ],
    "page": 1,
    "total_pages": 1
  }
}

PreviousSearch Domain Logs Next Create Inbound Route

Response

itemsarrayoptional

Route objects. See the route object schema below.

pageintegeroptional

Current page.

total_pagesintegeroptional

Total number of pages.

Route object

Field	Type	Description
`id`	string	Route ID (read-only).
`user_id`	integer	Owning user ID (read-only).
`domain_id`	integer	Owning domain ID (read-only).
`domain_name`	string	Domain name (read-only).
`description`	string	3-255 chars.
`expression_type`	string	One of `catch_all`, `custom`, `match_header`, `match_recipient`.
`header_name`	string	Required when `expression_type=match_header`.
`header_content`	string	Required when `expression_type=match_header`.
`recipient`	string	Required when `expression_type=match_recipient`.
`custom_expression`	string	Required when `expression_type=custom` (expression syntax).
`regex_enabled`	boolean	Treat expression content as regex.
`forward_list`	string[]	Non-empty list of email addresses and/or callback URLs.
`dmarc_alignment`	boolean	Require DMARC alignment.
`require_spf`	boolean	Require SPF pass.
`require_dkim`	boolean	Require DKIM pass.
`skip_spam_check`	boolean	Skip spam filtering.
`stop`	boolean	Stop processing further routes when matched.
`priority`	integer	1 (highest) to 100 (lowest).
`created_at`	string	RFC3339 timestamp (read-only).

Sample Response

200 OK

{
  "data": {
    "items": [
      {
        "id": "66a1...",
        "domain_id": 123,
        "description": "Support inbox",
        "expression_type": "match_recipient",
        "recipient": "[email protected]",
        "forward_list": ["[email protected]"],
        "priority": 10,
        "stop": true
      }
    ],
    "page": 1,
    "total_pages": 1
  }
}