MailerGetSuppressions¶
GET mailer/suppressions/list
Returns the suppression entries of the brand: address, why it is suppressed, where the entry came from, and when it expires.
Grouping by domain shows a pattern worth noticing — a whole corporate domain rejecting mail
is usually a reputation or DNS problem, not a set of dead mailboxes.
Access Control¶
Allowed roles: admin, leader.
Request¶
GET request
GET https://{broker_domain}/mailer/suppressions/list?limit=100&orderBy=%5B%22id%22%2C%22DESC%22%5D&count=%5B%22id%22%5D
Authorization: <JWT_TOKEN>
{
"command": "MailerGetSuppressions",
"extID": "1",
"data": {
"limit": 100,
"orderBy": [
"id",
"DESC"
],
"count": [
"id"
]
}
}
const res = await platform.MailerGetSuppressions({
limit: 100,
orderBy: [
"id",
"DESC"
],
count: [
"id"
]
});
Request Data¶
| Field | Type | Required | Description |
|---|---|---|---|
limit |
int | No | Page size, 1..1000, default 100 |
offset |
int | No | Rows to skip |
orderBy |
array | No | Sorting, for example ["id", "DESC"] |
count |
array | No | Row count aggregate, ["id"] |
where |
object | No | Filters, see Table filter syntax |
Response Data¶
source tells a provider-reported entry (PROVIDER) from an operator action (CRM), an import, or a recipient clicking unsubscribe (RECIPIENT).
{
"rows": [
{
"id": 31,
"brand": "default",
"email": "[email protected]",
"domain": "example.com",
"reason": "HARD_BOUNCE",
"source": "PROVIDER",
"description": "550 5.1.1 user unknown",
"emailId": 812,
"expiresAt": null,
"createdAt": "2026-08-24 13:44:02"
}
],
"count": [ { "id": 1 } ]
}
Errors¶
| Code | Error | Description |
|---|---|---|
401 |
PERMISSION_DENIED |
Session may not read the suppression list |