List suppressed addresses

GET

/v1/suppressions

curl --request GET \
  --url 'https://api.mailerdash.com/v1/suppressions?limit=100&offset=0&reason=bounce' \
  --header 'Authorization: Bearer <token>'

• Production
• Local development

Returns all addresses on the suppression list. Any valid API key can query.

Authorizations

• BearerAuth

Parameters

Query Parameters

limit

integer

default: 100 <= 1000

offset

integer

0

reason

string

Allowed values: bounce complaint manual

Filter by suppression reason

email

string

Partial email search

Responses

200

Paginated list of suppressed addresses

Media type application/json

object

total

integer

limit

integer

offset

integer

items

Array<object>

object

email

string

reason

string

code

string

nullable

added_at

string

Example ^generated

{
  "total": 1,
  "limit": 1,
  "offset": 1,
  "items": [
    {
      "email": "example",
      "reason": "example",
      "code": "example",
      "added_at": "example"
    }
  ]
}

401

Unauthorized