Sign in
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

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

beforestring

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

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

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
    }
  ]
}

Changes

Changed in 1 of the 41 revisions of this API.13

  • f67a043e319013See the full diff
    • ▲

      the query request parameter override_type was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value rev_share to the query request parameter override_type

      request-parameter-enum-value-added

    • ○

      added the new enum value standard to the query request parameter override_type

      request-parameter-enum-value-added

    • ○

      for the query request parameter override_type, the type/format was generalized from / to string/

      request-parameter-type-generalized