Referrals

List referrals

A referral is a unique visit, not a person. It moves visit -> lead -> converted and expires at expires_at, written from the program's cookie window at creation.

Scope: read

get/v1/referrals

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/referrals
  • Auth: HTTP bearer

Query parameters

program_idstring required

Required on every list

Example:prg_7uSyy9FqVLCFWrdPeZaK
limitstring

1 to 100, default 25

Example:25
starting_afterstring

Object id; returns the page after it (older)

ending_beforestring

Object id; returns the page before it (newer)

string
OR
string[]
string
OR
string[]
partner_idstring
status'visit' | 'lead' | 'converted'

Response

Referrals

has_moreboolean required

Pass the last object's id as starting_after to fetch the next page

total_countinteger required

Count of every object matching the filters, ignoring the cursor

Example response

{
  "data": [
    {
      "id": "ref_7uSyy9FqVLCFWrdPeZaK",
      "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
      "partner_id": "part_7uSyy9FqVLCFWrdPeZaK",
      "link_id": "lnk_7uSyy9FqVLCFWrdPeZaK",
      "expires_at": "2026-08-21T10:15:30.000Z",
      "created_at": "2026-08-21T10:15:30.000Z",
      "updated_at": "2026-08-21T10:15:30.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.