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

# List email suppressions

`GET /v1/email/suppressions`

## Request

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

Returns the workspace's suppressed email addresses as a paginated list, newest first. Pass an address in the `email` parameter to narrow the page to that address.

The `email` filter matches by prefix rather than exactly, so `bob@example.com` also returns a suppressed `bob@example.com.au`. Compare the `email` on each record before treating the address you asked about as suppressed.

An address can appear more than once because Bird keeps one suppression record per reason. Delivery stays blocked while any blocking record for the address remains.

## Query parameters

- `email` string
- `reason` 'hard_bounce' | 'complaint' | 'unsubscribe' | 'manual'
- `scope_type` 'workspace' | 'category' | 'audience' | 'topic' | 'contact' | 'domain'
- `limit` integer
- `starting_after` string
- `ending_before` string

## Headers

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

## Response `200`

Paginated list of suppressions.

- SuppressionList
  - `data` Suppression[], required: Page of suppression records.
    - `id` string, required
    - `email` string, email, required: The suppressed address, stored lowercase.
    - `scope` SuppressionScope, required
      - `type` 'workspace' | 'category' | 'audience' | 'topic' | 'contact' | 'domain', required: How widely the email suppression applies. Responses use `workspace`. The values `category`, `audience`, `topic`, `contact`, and `domain` are reserved and have no records. The record's `applies_to` field determines which message categories are blocked.
      - `id` string, required: Public ID or alias of the scoped resource. For workspace scope, this is the workspace ID.
    - `reason` string, required: Why the address is suppressed: - `hard_bounce`: A delivery permanently failed. - `complaint`: The recipient reported a message as spam. - `manual`: Added through the API or dashboard. - `unsubscribe`: The recipient opted out. Deprecated, and no new record carries it: an opt-out is a messaging preference rather than a suppression. Legacy records remain visible until they are moved to messaging preferences. An address can hold one record per reason. This list grows over time. Treat unknown values as informational rather than rejecting the record.
    - `origin` string, required: How the suppression came to exist: - `bounce_event`: Created automatically from a hard bounce. - `complaint_event`: Created from a spam complaint. - `api_key`: Added through the API with an API key. - `user`: Added by a user in the dashboard. - `unsubscribe_event`: The mailbox provider reported an opt-out. Deprecated with `reason: unsubscribe`. - `unsubscribe_link`: The recipient used a Bird unsubscribe link. Deprecated with `reason: unsubscribe`. This list grows over time. Treat unknown values as informational rather than rejecting the record.
    - `applies_to` string, required: Which sends the suppression blocks. - `all`: blocks every message category, including transactional. - `non_transactional`: blocks marketing but allows transactional messages. A recipient who complained can therefore still receive mail such as password resets. - `category`: scopes the block to a preference category and blocks every category until one is set. This list grows over time, and any value other than `non_transactional` blocks every category, so treat an unknown value as blocking the send.
    - `source_email_id` string
    - `source_recipient_id` string
    - `created_at` string, date-time, required: When the address was suppressed.
  - `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)