---
title: "List referrals"
method: GET
path: "/affiliate-referrals"
tags: ["Affiliates"]
---

# List referrals

`GET /affiliate-referrals`

## Request

- Base URL: `https://api.supersendtx.com`
- URL: `https://api.supersendtx.com/affiliate-referrals`
- Auth: HTTP bearer

## Query parameters

- `limit` integer
- `cursor` string
- `status` string
- `source` 'link' | 'coupon' | 'manual' | 'api' | 'checkout' | 'partner'
- `affiliate_id` string
- `email` string
- `created_after` string, date-time
- `created_before` string, date-time

## Response `200`

A page of referrals

- AffiliateReferralListResponse
  - `data` AffiliateReferral[], required
    - `object` 'affiliate_referral', required
    - `id` string, required
    - `affiliate_id` string, required
    - `status` 'pending_review' | 'lead' | 'trialing' | 'active' | 'cancelled' | 'refunded' | 'rejected', required
    - `source` 'link' | 'coupon' | 'manual' | 'api' | 'checkout' | 'partner', required
    - `email` string, email, nullable
    - `stripe_customer_id` string, nullable
    - `sub_id` string, nullable: The `sub` tag the partner put on the link
    - `blocked_reason` 'self_referral' | 'duplicate' | 'expired' | 'manual' | 'suspended', nullable: Set on flagged referrals, which never earn
    - `revenue_cents` integer
    - `currency` string, nullable
    - `converted_at` string, date-time, nullable
    - `expires_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `has_more` boolean, required
  - `next_cursor` string, nullable, required

## Other responses

- `400`: Validation error (`details.fields` names each bad field)
- `401`: Missing or invalid API key
- `403`: The API key is not full access, or the action is not allowed

---

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