Skip to main content
GET
/
suppressions
List all suppressions for the team
curl --request GET \
  --url https://api.lettermint.co/v1/suppressions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "email",
      "value": "<string>",
      "reason": "spam_complaint",
      "scope": "global",
      "project_id": "<string>",
      "route_id": "<string>",
      "suppressed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "path": "<string>",
  "per_page": 123,
  "next_cursor": "<string>",
  "next_page_url": "<string>",
  "prev_cursor": "<string>",
  "prev_page_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Team API token. Find this in your team settings.

Query Parameters

​
sort
string
default:-created_at

Available sorts are value, created_at, reason. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -value.

​
page[size]
integer
default:30

The number of results that will be returned per page.

​
page[cursor]
string

The cursor to start the pagination from.

​
filter[scope]
string

Filter by scope (team, project, route)

​
filter[route_id]
string

Filter by route ID

​
filter[project_id]
string

Filter by project ID

​
filter[value]
string

Search by email/domain value (partial match)

​
filter[reason]
enum<string>
Available options:
spam_complaint,
hard_bounce,
unsubscribe,
manual

Response

200 - application/json

Paginated set of SuppressedRecipientData

​
data
SuppressedRecipientData · object[]
required
​
path
string | null
required

Base path for paginator generated URLs.

​
per_page
integer
required

Number of items shown per page.

​
next_cursor
string | null
required

The "cursor" that points to the next set of items.

​
next_page_url
string<uri> | null
required
​
prev_cursor
string | null
required

The "cursor" that points to the previous set of items.

​
prev_page_url
string<uri> | null
required