Skip to main content
GET
/
v1
/
affiliations
List
curl --request GET \
  --url https://{defaultHost}/v1/affiliations \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/affiliations"
  },
  "data": [
    {
      "id": "f4835a6b-008d-446f-9712-60dea7308f10",
      "object": "affiliation",
      "active": true,
      "bio": null,
      "code": "8EA55E5D",
      "email": "[email protected]",
      "first_name": "Caryn",
      "last_name": "Bernier",
      "metadata": {},
      "payout_email": null,
      "url": null,
      "portal_url": "http://app.example.com/portal_redirect/affiliations/f4835a6b-008d-446f-9712-60dea7308f10",
      "referral_url": "?aff=8ea55e5d",
      "total_commission_amount": 0,
      "total_not_paid_commission_amount": 0,
      "commission_structure": null,
      "discarded_at": null,
      "created_at": 1767909666,
      "updated_at": 1767909666
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
active
boolean

Only return objects that are active or not.

​
email
string

Only return objects with the given email.

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

​
query
string

The query to be used for full text search of this collection.

​
sort
string

The sorting column and order to be used for this collection. Available sorting columns for this endpoint are created_at, name, and updated_at.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.