Get an inbound route
GET
/v1/email/inbound-routes/{route_id}
curl -X GET "https://us1.platform.bird.com/v1/email/inbound-routes/{route_id}" \
-H "Authorization: Bearer $TOKEN"Returns a single inbound route: its match rule, action, target mailbox, priority, and enabled state. Use List inbound routes to see every route in evaluation order.
Response Payload
id
string
required
Inbound route ID.
domain
string
required
The domain the route applies to.
match_type
string
required
How the route matches recipients. address matches one local part; catch_all matches every recipient on the domain that nothing else matched.
Possible values: address, catch_all
match_value
nullable string
required
The local part an address route matches. Null for catch_all routes.
action
string
required
What happens to matching mail. deliver_to_mailbox delivers it to target_mailbox_id; drop discards it silently, with nothing stored and no webhook fired.
Possible values: deliver_to_mailbox, drop
target_mailbox_id
nullable string
required
The mailbox that receives matching mail. Null for drop routes.
priority
integer
required
Evaluation order — lowest number wins. Explicit routes accept 11–1000 (default 100); the mailbox's own address always matches at priority 10.
enabled
boolean
required
Whether the route is evaluated. Disabled routes are kept but skipped.
created_at
string
required
When the route was created.
updated_at
string
required
When the route was last updated.