List affiliates

GET /affiliates

Error

A valid request URL is required to generate request examples

200

{
  "data": [
    {}
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "pageSize": 123,
    "hasMore": true,
    "requestId": "<string>",
    "nextCursor": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Use API key as Bearer token, for example: Bearer ak_live_xxx

Query Parameters

programId · string<uuid>

includeBlocked · boolean · default: false

search · string

Search affiliates by name or email (max 120 chars)

Maximum string length: 120

sortBy · enum<string>

Sort field

Available options: createdAt, totalClicks, totalRevenue, name

sortOrder · enum<string> · default: desc

Sort direction

Available options: asc, desc

status · enum<string>

Filter by affiliate status

Available options: approved, blocked

source · enum<string>

Filter affiliates by application source

Available options: browser, api, mcp, invite, import

cursor · string

limit · integer

Required range: 1 <= x <= 100

page · integer

Required range: x >= 1

pageSize · integer

Required range: 1 <= x <= 100

offset · integer

Required range: x >= 0

Response

200 - application/json

Affiliates list

data · object[] · required

meta · object · required

Show child attributes