Skip to main content
GET
List affiliates
Returns the affiliates of your white-label program, with their registration data, groups and additional fields. Requires scope whitelabel:affiliates:read.

Authorizations

x-api-key
string
header
required

Brand key created in the dashboard.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
limit
integer
default:20

Items per page. Values above 100 return 400.

Required range: 1 <= x <= 100
status
enum<string>

Filter by status in your program.

Available options:
pending,
active,
inactive

Search by name, e-mail or document.

Maximum string length: 100
clusterId
string<uuid>

Only affiliates of this group.

updatedSince
string<date-time>

Only affiliates changed at or after this date (ISO 8601).

Response

Paginated affiliates

data
object[]
required
meta
object
required