List Suppressions
List suppressed email addresses for the account, paginated.
List suppressed email addresses for the account. Results are paginated and can be searched.
Scope: suppressions.read
Query Parameters
searchstringoptionalOptional search term to filter suppressions by email address.
pageintegeroptionalPage number.
per_pageintegeroptionalItems per page (minimum 10, maximum 100).
Response
suppressionsarrayoptionalList of suppression objects, each with id, email_address, and reason.
totalintegeroptionalTotal number of suppressions.
pageintegeroptionalCurrent page.
per_pageintegeroptionalPage size.
total_pagesintegeroptionalTotal number of pages.
Sample Response
200 OK
{
"data": {
"suppressions": [
{
"id": 456,
"email_address": "[email protected]",
"reason": "Manually added"
}
],
"total": 1,
"page": 1,
"per_page": 25,
"total_pages": 1
}
}