Sign in
Suppressions

List suppressed recipients

Lists the recipients this company cannot reach, newest suppression first by default.

Four product-level suppression types appear:

  • suppressionType: invalid_recipient - SMTP evidence conclusively identifies an invalid destination. It is global, visible to companies associated with the address, and protected.
  • suppressionType: unknown_hard_bounce - a permanent/undetermined failure without enough evidence to declare the inbox invalid. It is company-scoped and protected.
  • suppressionType: soft_bounce_escalation - repeated delivery failures from this company. It is company-scoped and removable.
  • suppressionType: complaint - the recipient reported this company's email as spam. It is company-scoped and protected.

The platform-wide list is never exposed: a global row is returned only when the address is already associated with the authenticated company.

get/suppressions

Query parameters

searchstring

Case-insensitive substring filter on the recipient email address.

pageinteger

1-based page number.

limitinteger

Entries per page (max 100).

sort'suppressedAt' | 'email' | 'status'

Field to order by. status lists removable workspace escalations before protected suppressions. An unrecognized value falls back to suppressedAt rather than failing the request - read sortBy in the response to confirm what was applied.

order'asc' | 'desc'

Sort direction. Defaults to desc for suppressedAt and status, asc for email.

Response

Suppressed recipients

successboolean
totalinteger
pageinteger
limitinteger
hasMoreboolean
sortBy'suppressedAt' | 'email' | 'status'

The sort field actually applied.

sortOrder'asc' | 'desc'

The sort direction actually applied.

Example response

{
  "success": true
}

Changes