Suppressions

List suppressions

GET
/api/v1/suppressions

Lists suppressed addresses (the do-not-send list). Filter by reason. Requires a write-scope key.

Authorization

bearerAuth write
headerAuthorizationBearer <token>

An API key from the dashboard under Settings → API keys, sent as Authorization: Bearer aem_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see messages, contacts and metrics. Changes nothing, and cannot send.
  • write — everything read does, plus managing templates, contacts, automations, segments and suppressions. This is what editing a template needs.
  • admin — everything write does, plus sending configuration: domains, senders, webhook registration, kill switch, daily cap, brand.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Delivering mail to a real inbox needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

Give your application the lowest tier that works. Most need write and the grant — the dashboard mints that combination as Send + manage; Manage only is the same rung with the grant withheld.

Scope: write

Query Parameters

reason?string

unsubscribe | invalid | bounce | complaint | manual.

Value in"unsubscribe""invalid""bounce""complaint""manual"
limit?integer

Page size (1–500, default 100).

cursor?string

Opaque — pass the previous page's next_cursor to fetch the next page. A malformed cursor is refused, never treated as page one.

Response Body

Suppressed addresses.

application/json
  1. response
data*array<>
object*"list"
Value in"list"
has_more*boolean

More rows exist after this page.

next_cursor*|

Pass as ?cursor= for the next page. Null on the last page.

Example Request
curl -X GET 'https://sendandretain.com/api/v1/suppressions?reason=bounce'
Example Response
{  "data": [    {}  ],  "object": "list",  "has_more": true,  "next_cursor": "string"}