Skip to main content
GET
List suppressed email addresses

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Query Parameters

limit
integer

Page size (default 50, max 200). Coerced number falls back to the default on a malformed value.

offset
integer

Zero-based row offset for pagination.

Substring filter on the suppressed address.

reason
string

Filter by suppression reason (bounce, complaint, unsubscribe, manual).

Response

The paged suppression entries inside the standard { data, meta } envelope — data.entries is the array of entries, with data.total, data.limit, and data.offset carrying the pagination shape.

The paged suppression entries inside the standard { data, meta } envelope — data.entries is the array of entries, with data.total, data.limit, and data.offset carrying the pagination shape.

data
object
required