Skip to main content
GET
List Affiliates

Headers

x-api-key
string
required

The secret API key.

Query Parameters

limit
number
default:100

How many affiliates to return, from 1 to 100.

Required range: 1 <= x <= 100
Example:

100

offset
number
default:0

How many affiliates to skip before the page.

Required range: x >= 0
Example:

0

group_ids
string<uuid>[]

Only the affiliates of these affiliate groups, by id, up to 5. Given as a list: group_ids[]=<id>&group_ids[]=<id>; a single id may be given bare. Omit for every group. Cannot be combined with group_slugs.

Maximum array length: 5
Example:
group_slugs
string[]

Only the affiliates of these affiliate groups, by slug, up to 5. Given as a list: group_slugs[]=<slug>&group_slugs[]=<slug>; a single slug may be given bare. Omit for every group. Cannot be combined with group_ids.

Maximum array length: 5
Example:
sort_by
enum<string>
default:started_at

The field to order the affiliates by. name orders A to Z; every other field largest first, started_at newest first. profit is revenue less earnings; followers is the summed audience across Instagram, TikTok and YouTube, with affiliates whose audience is unknown last. Defaults to started_at.

Available options:
name,
claims,
conversions,
revenue,
earnings,
profit,
followers,
started_at
Example:

"revenue"

Response

The page of affiliates.

data
object
required