Sign in
Affiliates

List Affiliates

Returns the project approved affiliates with their group, all-time totals and connected platforms — the same data as the affiliates table in the dashboard. Newest joiner first unless sort_by names another field — then largest first, or A to Z for name. Note 1: this endpoint is only accessible with a secret API key. Note 2: up to 100 affiliates are returned per request; page through the rest with offset.

get/affiliates

Query parameters

limitnumber
Example:100

How many affiliates to return, from 1 to 100.

offsetnumber

How many affiliates to skip before the page.

group_idsstring[]

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.

[
  "a1b2c3d4-e5f6-7890-abcd-ef0123456701"
]
group_slugsstring[]

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.

[
  "creators"
]
sort_by'name' | 'claims' | 'conversions' | 'revenue' | 'earnings' | 'profit' | 'followers' | 'started_at'
Example:revenue

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.

Headers

x-api-keystring required

The secret API key.

Response

The page of affiliates.

Example response

{
  "data": {
    "affiliates": [
      {
        "id": "2772aded-9009-474c-a368-c887dda45b01",
        "name": "Jane Doe",
        "logo_url": "https://example.com/logo.png",
        "country": "US",
        "group": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456701",
          "name": "Creators",
          "slug": "creators",
          "color": "#6366F1"
        },
        "status": "approved",
        "claims": 120,
        "conversions": 34,
        "revenue": 249900,
        "earnings": 49980,
        "profit": 199920,
        "started_at": "2026-01-01T00:00:00.000Z",
        "platforms": [
          {
            "type": "instagram",
            "handle": "winwinkit",
            "followers": 12400
          }
        ],
        "application": {
          "answers": [
            {
              "type": "options",
              "question": "Where will you promote us?"
            }
          ]
        }
      }
    ],
    "pagination": {
      "limit": 100,
      "total": 512,
      "has_more": true
    }
  }
}

Changes

Changed in 1 of the 7 revisions of this API.1