GET
List email suppressions

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

email
string<email>

EXACT match on one address, which is how you ask "is this address suppressed" before a send. An address that is not suppressed returns an empty page, which is the answer rather than an error. It is never a prefix or a pattern: that would turn a suppression list into a directory to enumerate by guessing. Send the address as you hold it. Matching is exact and so is this platform's own send gate, so normalising first can report an address absent that the gate will not match either.

reason
enum<string>

Filter by why the address was suppressed. A value outside the enum is a 400 rather than an empty page: "nobody was suppressed for that reason" and "there is no such reason" are different facts, and a client told the former concludes its complaint feed arrived when it did not.

Available options:
bounce,
complaint,
manual,
unsubscribe
limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object