Skip to main content
GET
List Suppressions

Authorizations

X-SubAccount-ApiKey
string
header
required

This api key can be used only for sub account level operations

Query Parameters

from
string<date>
required

Start date for suppression records (inclusive). Format YYYY-MM-DD.

Example:

"2024-01-01"

to
string<date>
required

End date for suppression records (inclusive). Max 60 days from from date.

Example:

"2024-01-31"

limit
integer
default:20

Number of records to return per request. Default 20, max 100.

Example:

50

offset
integer
default:0

Number of initial records to skip for pagination.

Example:

0

Case-insensitive search against suppression email addresses.

Example:

"@example.com"

type
enum<string>

Filter by suppression type. Omit to return all types.

Available options:
hardBounce,
manual,
spamComplaint,
unsubscribe
Example:

"hardBounce"

Response

200 - application/json

A list of suppressions

id
integer<int64>

Unique identifier for the suppression record

Example:

35

email
string<email>

The suppressed email address

Example:

"bounced@example.com"

reason
enum<integer>

Reason code for the suppression:

  • 0 = Manual (added via API or dashboard)
  • 1 = Unsubscribe (recipient clicked unsubscribe link)
  • 2 = Hard Bounce (permanent delivery failure)
  • 3 = Spam Complaint (recipient marked as spam)
  • 4 = Hard Bounce (detected by post-send validation)
Available options:
0,
1,
2,
3,
4
Example:

2

reasonText
enum<string>

Human-readable suppression reason

Available options:
manual,
unsubscribe,
hardBounce,
spamComplaint
Example:

"hardBounce"

smtpError
string

SMTP error message from the receiving server (only for hard bounce suppressions). Useful for diagnosing delivery issues.

Example:

"550 5.1.1 The email account that you tried to reach does not exist"

messageUUID
string

UUID of the message whose bounce/complaint caused this suppression. Empty for manually added suppressions. Useful for tracing the origin.

Example:

"3f2504e0-4f89-41d3-9a0c-0305e82c3301"

created
integer<int64>

UNIX epoch timestamp in nanoseconds when the suppression was added

Example:

1704067200000000000