Skip to content

List Suppressions

GET
/contacts/suppressions

Paginated org-wide list of active suppressions.

Unlike the app’s Data -> Suppressions grid (which joins contact/company names for display), this is the raw ledger — no PII, see module docstring. Resolve a row’s contact via GET /contacts/{contact_id}.

Authorizations

Parameters

Query Parameters

channel
Any of:
string
Allowed values: all email phone linkedin

Filter: all | email | phone | linkedin

category
Any of:
string
Allowed values: contact_initiated org_initiated system

Filter: contact_initiated | org_initiated | system

limit
integer
default: 50 >= 1 <= 500
offset
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Array<object>

One row of the central contact_suppressions ledger.

object
category
required

Contact_initiated | org_initiated | system

string
channel
required

All | email | phone | linkedin

string
contact_id
required
integer
created_at
Any of:
string
created_by
Any of:
string
id
required
string
reason
Any of:
string
revision
Any of:
integer
source
Any of:
string
source_ref
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string