---
title: "List receive rules"
method: GET
path: "/v1/email/mailboxes/{mailbox_id}/receive-rules"
tags: ["email-mailboxes"]
---

# List receive rules

`GET /v1/email/mailboxes/{mailbox_id}/receive-rules`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/receive-rules`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns a paginated list of the mailbox's receive rules, oldest first. Filter by action to see only allow or only block entries.

## Query parameters

- `action` 'allow' | 'block'
- `limit` integer
- `starting_after` string
- `ending_before` string

## Headers

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

## Response `200`

Paginated list of receive rules.

- ReceiveRuleList
  - `data` ReceiveRule[], required
    - `id` string, required
    - `mailbox_id` string, required
    - `action` 'allow' | 'block', required: What the rule does when it matches. Block rules always win: over allow rules and over the reply admission on allowlist mailboxes.
    - `entry` string, required: The sender address or domain the rule matches. Domains also match their subdomains.
    - `entry_type` 'address' | 'domain', required: Whether the entry is a full address or a domain.
    - `note` string, nullable, required: Your own note about why the rule exists. `null` when unset.
    - `created_at` string, date-time, required: When the rule was created.
  - `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/6dfce1179799?raw)