Sign in
Affiliates

List Affiliate Payouts

Returns the affiliate's payouts from the project — both the monthly performance payouts their codes earn and the custom ones the project created — latest period first. Note 1: this endpoint is only accessible with a secret API key. Note 2: up to 100 payouts are returned per request; page through the rest with offset.

get/affiliates/{affiliate_id}/payouts

Path parameters

affiliate_idstring required

The id of the affiliate whose payouts to list.

Query parameters

limitnumber
Example:100

How many payouts to return, from 1 to 100.

offsetnumber

How many payouts to skip before the page.

Headers

x-api-keystring required

The secret API key.

Response

The page of payouts.

Example response

{
  "data": {
    "payouts": [
      {
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "affiliate_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "custom",
        "status": "pending",
        "amount": 25000,
        "description": "Launch campaign video",
        "period_start": "2026-09-01",
        "period_end": "2026-09-15",
        "created_at": "2026-09-29T10:15:00.000Z"
      }
    ],
    "pagination": {
      "limit": 100,
      "total": 512,
      "has_more": true
    }
  }
}

Changes

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