List opted-out contacts
Contacts
List opted-out contacts
Retrieve the tenant’s opt-out (suppression) records with opaque cursor pagination. Optional channel (sms, email, whatsapp, voice, rcs, …) and free-text search (across contact identifier and reason) query parameters narrow the list; an empty or repeated filter degrades gracefully to “no filter” rather than erroring, so the Compliance → Opt-outs tab always returns a page.
GET
List opted-out contacts
Authorizations
Dashboard JWT token from Clerk
Query Parameters
Filter to one channel (sms, email, whatsapp, voice, rcs, …).
Free-text match across contact identifier and reason.
Page size (1-100, default 25).
Required range:
1 <= x <= 100Opaque pagination cursor from a previous page's meta.pagination.