---
title: "Get an email suppression"
method: GET
path: "/v1/email/suppressions/{suppression_id}"
tags: ["email-suppressions"]
---

# Get an email suppression

`GET /v1/email/suppressions/{suppression_id}`

## Request

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

Returns one suppression record:

- The address.
- Why it is suppressed (`reason`).
- How the record came to exist (`origin`).
- Which message categories it blocks (`applies_to`).

To find a record when you only know the address, use `GET /v1/email/suppressions` with the `email` parameter. An ID that does not exist in the workspace returns `404`.

## Headers

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

## Response `200`

Suppression object.

- Suppression
  - `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.

## 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)