Skip to main content
GET
List compliance mobile/email opt-outs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

Search by consumer name and account fields for the selected compliance tab.

Maximum string length: 255
sort
enum<string>
default:created-at

Mobile/email opt-out compliance sort field. Defaults to created-at when omitted.

Available options:
created-at,
consumer-name,
type,
contact,
master-account-number,
account-name,
placement-date
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
page
integer
default:1

Page number for paginated list responses.

Required range: x >= 1
per_page
integer
default:25

Number of records per page.

Required range: 1 <= x <= 100

Response

Compliance mobile/email opt-out records returned.

data
object[]
required
pagination
object
required
Last modified on July 20, 2026