Skip to main content
GET
List call opt outs

Authorizations

Authorization
string
header
required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Query Parameters

limit
integer
default:100

Specifies limit for this query parameter.

Value constraints

Required range: 1 <= x <= 500
cursor
string<uuid>

Specifies cursor for this query parameter.

Value constraints

phoneNumber
string

Phone number in international format.

Value constraints

Pattern: ^\+[1-9]\d{1,14}$
bsuid
string

Business-scoped user identifier (BSUID), scoped to the owning business portfolio.

Value constraints

Pattern: ^[A-Z]{2}\.[A-Za-z0-9]{1,128}$

Response

One page of entries.

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object[]
required

Structured data carried by this object.

page
object
required

Specifies page for this management platform access list call opt outs response.