---
title: "Get an Apple Messages for Business suppression"
method: GET
path: "/v1/amb/suppressions/{suppression_id}"
tags: ["amb-suppressions"]
---

# Get an Apple Messages for Business suppression

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

## Request

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

Returns the suppression episode for the given ID, including one that has already ended. An ended episode keeps its dates and reports when and how it ended.

## Headers

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

## Response `200`

The requested suppression episode.

- AMBSuppression: One retained suppression episode for an address. A null account scope covers the same address in every account in the workspace; it does not link different opaque identities.
  - `id` string, required
  - `business_account_id` string, required
  - `address` string, required: Canonical E.164 phone number, or the exact opaque identifier Apple supplied.
  - `address_type` 'phone_number' | 'opaque_user_id', required: What kind of value `address` holds. - `phone_number` means `address` is the customer's phone number. Apple's CloseSession event carries a phone number rather than an opaque identifier, so a suppression opened by a close on a conversation identified by phone number takes this kind. - `opaque_user_id` means `address` is the opaque identifier Apple assigns to the customer's conversation with the business, stable across a close and a later re-initiation.
  - `reason` string, required: Why the handle is suppressed. `manual` means it was added directly through this API or the dashboard. `opted_out` covers every case where Apple or the customer signaled they should not be contacted: a close, a permanent delivery failure, a declined invitation, or a stop keyword. This list grows over time, so treat an unknown value as informational rather than rejecting the record.
  - `origin` string, required: Who created the episode. user and api_key identify manual blocks. close_session and gone are protected automatic conversation facts. Phone invitation opt-outs are recorded as preferences.
  - `applies_to` string, required: Paths blocked by this episode. Treat unknown values as blocking.
  - `source_message_id` string
  - `source_event_id` string
  - `source_end_message_id` string
  - `effective_at` string, date-time, required: When the blocking state took effect.
  - `created_at` string, date-time, required: When Bird recorded this episode.
  - `ended_at` string, date-time, nullable, required: When Bird recorded the end, or null while active.
  - `ended_reason` string, nullable, required: What ended the episode, or null while active. Customers can end only manual episodes.
  - `ended_effective_at` string, date-time, nullable, required: When the end took effect, or null while active.

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