---
title: "Filter suppressions"
method: POST
path: "/suppressions"
tags: ["suppressions"]
---

# Filter suppressions

`POST /suppressions`

## Request

- Base URL: `https://pro.api.serversmtp.com/api/v2`
- URL: `https://pro.api.serversmtp.com/api/v2/suppressions`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `consumerKey` and API key in header `consumerSecret`

Get Suppressions Data

## Request body

- SuppressionFilterOrderPageRequestBody
  - `page` integer, nullable: Page number. Must be an integer greater than 0.
  - `limit` integer, nullable: The number of rows per page to return. Must be an integer greater than 0.
  - `from` string, date, required: Start date
  - `to` string, date, required: End date
  - `tz` string: Timezone Offset
  - `filter` string: Query to search
  - `filter_by` SuppressionSource[]: Filter by
  - `smart_search` boolean, nullable: Smart search
  - `restrict` SuppressionRestriction[]: xxxx
    - `by` 'sender' | 'recipient' | 'reason' | 'subject': Field to restrict by
    - `operator` 'include' | 'exclude': XXX
    - `filter` string
    - `smart_search` boolean, nullable: Smart search
  - `orderby` 'date' | 'source' | 'recipient' | 'reason': Field to sort by
  - `ordertype` 'asc' | 'desc': Order Ascending or Descending.

## Response `200`

Sucess

Get Filtered Suppressions Data.

- SuppressionsSucessResponsetBody
  - `count` integer
  - `results` Suppression[]
    - `date` string
    - `sender` string, nullable
    - `source` 'manual' | 'bounce' | 'spam' | 'unsubscribe' | 'validation_failed'
    - `subject` string
    - `recipient` string, email, nullable
    - `reason` string, nullable

## Other responses

- `401`: Unauthorized This API requires a valid API Key to be provided. (Use [/authentication/authorize](#/authentication/AuthenticationLogin) to obtain an API Key) Produces: * missing_authorization_key * invalid_authorization_key * account_is_inactive

---

[API](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis.md) - [All operations](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis/revisions/8503e099b215?raw)