v8

OpenAPI 3.1.02026-08-033623795.0 MB
Affiliates

List overrides

Returns a paginated list of overrides for an affiliate.

Required permissions:

  • affiliate:basic:read
get/affiliates/{id}/overrides

Path parameters

idstring required
Example:aff_xxxxxxxxxxxxxx

The affiliate ID.

Query parameters

afterstring nullable

Returns the elements in the list that come after the specified cursor.

beforestring nullable

Returns the elements in the list that come before the specified cursor.

firstinteger nullable

Returns the first n elements from the list.

Example:42
lastinteger nullable

Returns the last n elements from the list.

Example:42
override_type'standard' | 'rev_share'

The role of an affiliate override (standard or rev_share)

Response

A successful response

Example response

{
  "data": [
    {
      "commission_value": 6.9,
      "id": "affov_xxxxxxxxxxxx",
      "plan_id": "plan_xxxxxxxxxxxxx",
      "total_referral_earnings_usd": 6.9
    }
  ]
}