This method is intended to retrieve a list of Suppressions. It can be used to search using a specific set of filters. All parameters are optional. Data is passed via query parameters in the URL.
A Suppression (suppression rule) is a website feature that prevents sending emails to a specific address. For example, a user has unsubscribed or reported spam, or the email address does not exist at all. The system detects a situation where emails can no longer be sent to this address and creates a suppression rule.
HTTP request
- URL:
https://sender-solutions.com/api/suppressions/suppressions-list/ - HTTP Method: GET
Example request with the maximum set of parameters using cURL
curl --location 'https://sender-solutions.com/api/suppressions/suppressions-list/?offset=0&limit=10&Id=25&BaseId=0&Email=username%40example.com&Type=unsubscribe' \
--header 'Authorization: {{api-token}}'
Field description
| Field | Type | Required | Description |
|---|---|---|---|
offset | int | The number of records from the final result set that should be skipped. Used to enable paginated (chunked) data retrieval. Default is 0. | |
limit | int | The maximum number of records to be returned in the response to this request. Used to enable paginated (chunked) data retrieval. Default is 100, maximum is 2000. | |
Id | int | The suppression rule identifier. If specified, it is used as a filter. | |
BaseId | int | The subscriber base identifier. If specified, it is used as a filter. The value 0 represents all bases, meaning the rule is not limited to any specific base. When the value 0 is specified, filtering is still applied. To avoid filtering by the BaseId field, this field must not be passed at all. | |
Email | string | Email address. If specified, it is used as a filter. | |
Type | string | Rule type. If specified, it is used as a filter. Possible values: spam — spam complaints, unsubscribe — unsubscribe from mailing list, hard_bounce — permanent delivery errors, soft_bounces — temporary delivery errors that occurred repeatedly. |
Example of a successful JSON response
{
"success": true,
"SuppressionsList": {
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Suppressions": [
{
"Id": 2,
"BaseId": 0,
"Email": "username@example.com",
"Type": "unsubscribe",
"CreatedAt": 1770505912
}
]
}
}In this response, the SuppressionsList.TotalCount field indicates the total number of records found for the request. The SuppressionsList.Offset and SuppressionsList.Limit fields duplicate the values from the request, taking into account the minimum and maximum value constraints. The SuppressionsList.Suppressions field contains an array of suppression rules. The SuppressionsList.Suppressions.*.CreatedAt field represents the rule creation time in UnixTimestamp format.