List suppressions

GEThttps://api.mailfully.com/v1/suppressions

List the organization's suppressed addresses, newest first, with keyset pagination. Suppressions are org-global (not partitioned by environment). Stored addresses are canonical lowercase, so filter with a lowercased address. Requires the read:suppressions or manage:suppressions scope.

Loading code example

Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limitintegerdefault: 25

Maximum rows to return. Default 25, clamped to [1, 100].

Required range: x >= 1, x <= 100

Default: 25

cursorstring

Opaque pagination cursor from a previous response's `next_cursor`.

emailstring

Exact-match filter (case-sensitive; stored values are lowercase).

reasonstring

Exact-match filter. Effective values are `manual`, `hard_bounce`, and `complaint`.

Response

application/json

A page of suppressions.

dataarray<object>required

data.idstringrequired

The suppression id (a bare ULID, no prefix).

data.emailstringrequired

The suppressed address, canonical lowercase.

data.reasonstringrequired

One of `manual`, `hard_bounce`, or `complaint`.

data.sourcestringrequired

One of `dashboard` or `ses_notification`.

data.created_atstring<date-time>required

has_morebooleanrequired

next_cursorstringrequired