---
title: "List referrals"
method: GET
path: "/v1/referrals"
tags: ["Referrals"]
---

# List referrals

`GET /v1/referrals`

## Request

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

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`

## Query parameters

- `program_id` string, required: Required on every list
- `limit` string: 1 to 100, default 25
- `starting_after` string: Object id; returns the page after it (older)
- `ending_before` string: Object id; returns the page before it (newer)
- `expand[]` union: Relations to embed: partner, link
  - string
  - string[]
- `include[]` union: Nothing to include on this resource
  - string
  - string[]
- `partner_id` string
- `status` 'visit' | 'lead' | 'converted'

## Response `200`

Referrals

- ReferralList
  - `data` Referral[], required
    - `id` string, required: Prefixed id (`ref_…`)
    - `object` 'referral', required
    - `program_id` string, required: Prefixed id (`prg_…`)
    - `partner_id` string, required: Prefixed id (`part_…`)
    - `link_id` string, nullable, required: Prefixed id (`lnk_…`)
    - `landing_url` string, nullable, required
    - `utm` unknown
    - `tracked_by` 'link' | 'coupon' | 'manual' | 'api', required
    - `status` 'visit' | 'lead' | 'converted', required
    - `expires_at` string, date-time, required: ISO-8601, UTC
    - `created_at` string, date-time, required: ISO-8601, UTC
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: Pass the last object's id as `starting_after` to fetch the next page
  - `total_count` integer, required: Count of every object matching the filters, ignoring the cursor

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)