Skip to main content
GET
List opted-out contacts

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Query Parameters

channel
string

Filter to one channel (sms, email, whatsapp, voice, rcs, …).

Free-text match across contact identifier and reason.

limit
integer

Page size (1-100, default 25).

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor from a previous page's meta.pagination.

Response

200 - application/json

A page of opt-out records in data, with the next cursor in meta.pagination.

data
object[]
meta
object