List suppressed addresses

List suppressed addresses

GET/api/v1/suppressions

GET /suppressions
curl -X GET 'https://www.unitpost.com/api/v1/suppressions' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "suppression",
      "id": "id_123",
      "email": "customer@example.com",
      "scope": "workspace",
      "reason": "bounce",
      "detail": "string",
      "note": "string",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve a list of email addresses that are blocked from receiving your mail, newest-first and cursor-paginated. The list includes your workspace's own suppressions AND the read-only Unitpost-wide (platform) entries that would block a send — so it's the complete answer to "why isn't this address getting mail?". Pass ?scope=workspace to hide platform rows. Add an address with Suppress an address or lift a block with Un-suppress an address. Requires the suppressions:read capability.

Parameters4 fields
FieldTypeDescription
limitinteger · queryMax rows to return (default 20, max 100).
afterstring · queryReturn rows after this id (forward paging).
beforestring · queryReturn rows before this id (backward paging).
scopestring · queryFilter by scope. `workspace` returns only your own suppressions; omit (or any other value) to also include read-only `platform` rows.
Response · 200 fields9 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
emailrequiredstring—
scoperequiredenumworkspace | platform—
reasonrequiredenumbounce | complaint | unsubscribe | manual | import | api—
detailrequiredobject—
noterequiredobject—
created_atrequiredstring—
updated_atrequiredstring—
200401403422

Search docs and guides

Search the docs and product guides.