Skip to main content
GET
/
v1
/
referral_items
List
curl --request GET \
  --url https://{defaultHost}/v1/referral_items \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/referral_items"
  },
  "data": [
    {
      "id": "c9228d77-2e36-443d-8623-ca9e0d66dd70",
      "object": "referral_item",
      "commission_amount": 580,
      "line_item": "50d10aee-a275-439c-9f20-5d805ea0f57a",
      "referral": "8d848cc8-2e2f-48f5-9f52-56d5c78a5e14",
      "created_at": 1773903582,
      "updated_at": 1773903582
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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.

​
page
integer

The page of items you want returned.

​
referral_ids[]
string[]

Only return objects that belong to the given referrals.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.