Skip to main content
GET
/
v1
/
referrals
List
curl --request GET \
  --url https://{defaultHost}/v1/referrals \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/referrals"
  },
  "data": [
    {
      "id": "642b18e0-ee03-4ce5-9515-5b3774352a55",
      "object": "referral",
      "commission_amount": 9900,
      "currency": "usd",
      "description": null,
      "live_mode": true,
      "manual": true,
      "refund_reduction_amount": 0,
      "status": "reviewing",
      "affiliation": "c6085d8c-edb7-44fa-9457-be66282c6586",
      "attributed_click": null,
      "checkout": null,
      "payout": null,
      "created_at": 1767909752,
      "updated_at": 1767909752
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
affiliation_ids[]
string[]

Only return objects that belong to the given affiliations.

​
checkout_ids[]
string[]

Only return objects that belong to the given checkouts.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
manual
boolean

Only return referrals that were manually created or not.

​
page
integer

The page of items you want returned.

​
payout_ids[]
string[]

Only return objects that belong to the given payouts.

​
status[]
string[]

Only return objects with the given status.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.