Skip to main content
GET
Node.js

Headers

X-Api-Key
string
required

Query Parameters

recipient
string
Maximum string length: 255
source
enum<string>
Available options:
api,
unsubscribe_link,
list_unsubscribe,
hard_bounce,
spam_complaint
created_before
string

The date and/or time before which the suppression entries were created. Format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ

created_after
string

The date and/or time after which the suppression entries were created. Format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ

limit
integer
default:1000

The maximum number of suppression entries to return. The default is 1000.

Required range: 1 <= x <= 1000
offset
integer
default:0

The number of suppression entries to skip before returning results. The default is 0.

Required range: x >= 0

Response

Successfully retrieved all suppression entries associated with the account.

suppression_list
object[]
required
Maximum array length: 1000