List suppressed addresses
GET/api/v1/suppressions
The workspace's suppression list, one page at a time. Useful for keeping a web shop in sync with unsubscriptions.
Scope
contacts:readRead contacts – the person behind the key must be all members.
Query parameters
limitinteger- The maximum number of items in the response (1–500, default 100).at least 1 · at most 500 · default 100
cursorstring- next_cursor from the previous response, for the next page. Omit for the first page.
reasonstring- Only suppressions of that type.
unsubscribedbouncedcomplainedmanualimported
Response
200 A page of suppressed addresses.
dataarray<object>requireddata[].emailstringrequireddata[].reasonstringrequired- unsubscribed, bounced, complained, manual or imported.
data[].detailstring | nullrequireddata[].created_atstring (time, ISO 8601)required- When the address was suppressed.
data[].contact_idstring | nullrequired- The contact with the address, if there is one that the key may see.
has_morebooleanrequired- There are more: fetch the next page with cursor=next_cursor.
next_cursorstring | nullrequired- Send as cursor for the next page. null on the last page.
Errors
- 429
- rate_limited