---
title: "List inbound routes"
method: GET
path: "/v1/email/inbound-routes"
tags: ["email-inbound-routes"]
---

# List inbound routes

`GET /v1/email/inbound-routes`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/email/inbound-routes`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns a paginated list of the workspace's inbound routes in evaluation order, lowest priority number first. Filter by domain or by enabled state.

## Query parameters

- `domain` string
- `enabled` boolean
- `limit` integer
- `starting_after` string
- `ending_before` string

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

Paginated list of inbound routes.

- InboundRouteList
  - `data` InboundRoute[], required: Page of inbound routes in evaluation order, with the lowest priority number first.
    - `id` string, required
    - `domain` string, required: The domain the route applies to.
    - `match_type` 'address' | 'catch_all', required: How the route matches recipients. `address` matches one local part. `catch_all` matches every recipient on the domain that nothing else matched.
    - `match_value` string, nullable, required: The local part an `address` route matches. `null` for `catch_all` routes.
    - `action` 'deliver_to_mailbox' | 'drop', 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.
    - `target_mailbox_id` string, required
    - `priority` integer, required: The order routes are tried in, lowest number first. Your own routes take a priority from 11 to 1000, and default to 100. A 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, date-time, required: When the route was created.
    - `updated_at` string, date-time, required: When the route was last updated.
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)