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 by ID.
Carga de respuesta
id
string
obligatorio
Inbound route ID.
domain
string
obligatorio
The domain the route applies to.
match_type
string
obligatorio
How the route matches recipients. address matches one local part; catch_all matches every recipient on the domain that nothing else matched.
match_value
nullable string
obligatorio
The local part an address route matches. Null for catch_all routes.
action
string
obligatorio
What happens to matching mail.
target_mailbox_id
nullable string
obligatorio
The mailbox that receives matching mail. Null for drop routes.
priority
integer
obligatorio
Evaluation order — lowest number wins. Explicit routes accept 11–1000 (default 100); the mailbox's own address always matches at priority 10.
enabled
boolean
obligatorio
Whether the route is evaluated. Disabled routes are kept but skipped.
created_at
string
obligatorio
When the route was created.
updated_at
string
obligatorio
When the route was last updated.