List inbound routes
GET
/v1/email/inbound-routes
curl -X GET "https://us1.platform.bird.com/v1/email/inbound-routes" \
-H "Authorization: Bearer $TOKEN" \
--url-query "domain=acme-support.eu.mailbox.bird.com" \
--url-query "limit=25"Returns a paginated list of the workspace's inbound routes in evaluation order — priority ascending, lowest number first. Filter by domain or by enabled state.
Parâmetros de consulta
domain
string
Filter to routes on this domain.
enabled
boolean
Filter by enabled state.
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Payload de resposta
data
array of object
obrigatório
Mostrar atributos secundários
data.id
string
obrigatório
Inbound route ID.
data.domain
string
obrigatório
The domain the route applies to.
data.match_type
string
obrigatório
How the route matches recipients. address matches one local part; catch_all matches every recipient on the domain that nothing else matched.
data.match_value
nullable string
obrigatório
The local part an address route matches. Null for catch_all routes.
data.action
string
obrigatório
What happens to matching mail.
data.target_mailbox_id
nullable string
obrigatório
The mailbox that receives matching mail. Null for drop routes.
data.priority
integer
obrigatório
Evaluation order — lowest number wins. Explicit routes accept 11–1000 (default 100); the mailbox's own address always matches at priority 10.
data.enabled
boolean
obrigatório
Whether the route is evaluated. Disabled routes are kept but skipped.
data.created_at
string
obrigatório
When the route was created.
data.updated_at
string
obrigatório
When the route was last updated.
next_cursor
nullable string
obrigatório
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obrigatório
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obrigatório
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.