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": "4dc39dcc-99a2-4136-ae7e-c175afc7737c",
      "object": "referral_item",
      "commission_amount": 580,
      "line_item": "04f4d22f-35cb-479e-93df-0afdae53d687",
      "referral": "5020e6c1-5dd0-462b-93ae-7dcdd9f55c35",
      "created_at": 1771429896,
      "updated_at": 1771429896
    }
  ]
}

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.