8503e099b215

latestOpenAPI 3.1.0MIT2026-08-0652106151.4 KB

suppressions

Filter suppressions

Get Suppressions Data

post/suppressions

Request body

pageinteger nullable

Page number. Must be an integer greater than 0.

limitinteger nullable

The number of rows per page to return. Must be an integer greater than 0.

fromstring date required

Start date

tostring date required

End date

tzstring

Timezone Offset

filterstring

Query to search

filter_bySuppressionSource[]

Filter by

smart_searchboolean nullable

Smart search

orderby'date' | 'source' | 'recipient' | 'reason'

Field to sort by

ordertype'asc' | 'desc'

Order Ascending or Descending.

Example request

{
  "page": 1,
  "limit": 10,
  "from": "2020-01-01",
  "to": "2025-12-31",
  "tz": "-07:00",
  "filter_by": [],
  "restrict": [
    {
      "by": "sender",
      "operator": "include",
      "filter": "a"
    }
  ],
  "orderby": "date",
  "ordertype": "desc"
}

Response

Sucess

Get Filtered Suppressions Data.

countinteger

Example response

{
  "count": 5,
  "results": [
    {
      "date": "2021-03-17 00:00:00",
      "sender": "andrea@emailchef.com",
      "source": "bounce",
      "subject": "Newsletter - September 2022",
      "recipient": "bounce1@turbo-smtp.com",
      "reason": "550 Error"
    },
    {
      "date": "2021-03-15 00:00:00",
      "sender": "alberto@emailchef.com",
      "source": "manual",
      "subject": "",
      "recipient": "bounce2@turbo-smtp.com",
      "reason": "manual inserted"
    },
    {
      "date": "2021-03-14 00:00:00",
      "sender": "alberto@emailchef.com",
      "source": "spam",
      "subject": "Newsletter - September 2022",
      "recipient": "topolino@turbo-smtp.com",
      "reason": "spam complaint"
    },
    {
      "date": "2021-03-14 00:00:00",
      "sender": "alberto@emailchef.com",
      "source": "unsubscribe",
      "subject": "Newsletter - September 2022",
      "recipient": "pippo@turbo-smtp.com",
      "reason": "unsubscribe from list pippo"
    },
    {
      "date": "2021-03-13 00:00:00",
      "sender": "alberto@emailchef.com",
      "source": "validation_failed",
      "subject": "Newsletter - September 2022",
      "recipient": "minnie@turbo-smtp.com",
      "reason": "validation failed last import"
    }
  ]
}