Skip to main content
GET
/
subaccount
/
suppression
List Suppressions
curl --request GET \
  --url https://api.sendpost.io/api/v1/subaccount/suppression \
  --header 'X-SubAccount-ApiKey: <api-key>'
[
  {
    "id": 35,
    "reason": 1,
    "email": "[email protected]",
    "created": 1567512491588025000
  },
  {
    "id": 37,
    "reason": 0,
    "email": "[email protected]",
    "created": 1567512491588023000
  }
]

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 the suppression records

​
to
string<date>
required

End date for the suppression records (Note: from should be earlier than to and the date range should not exceed 60 days)

​
limit
integer
default:20

Number of records to return per request

​
offset
integer
default:0

Number of initial records to skip

​
search
string

Case-insensitive search against suppression email

​
type
enum<string>

Type of suppression. Valid values: hardBounce, manual, spamComplaint, unsubscribe

Available options:
hardBounce,
manual,
spamComplaint,
unsubscribe

Response

200 - application/json

A list of suppressions

​
id
integer

The ID of the suppression

​
reason
integer

The reason for the suppression (0 = manual, 1 = unsubscribe, 2 = hard bounce, 3 = spam complaint)

​
smtp_error
string

SMTP error code in case of hard bounce suppression

​
email
string

The email address for the suppression

​
created
integer<int64>

UNIX epoch nano timestamp when the suppression was created