---
title: "List referrals"
method: GET
path: "/v1/projects/{project}/referrals"
tags: ["Referral Program"]
---

# List referrals

`GET /v1/projects/{project}/referrals`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/referrals`
- Auth: HTTP bearer

```bash
curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/referrals?status=converted&since=2026-10-01" \
  -H "Authorization: Bearer sbt_..."
```

Pages the friends affiliates brought in, newest first. `status` is `touched`, `converted`, `expired` or `rejected`; `affiliate_id` narrows to one affiliate; `since` keeps the referrals whose friend arrived on or after that instant, so a report can page only what happened after its last run.

## Path parameters

- `project` string, uuid, required

## Query parameters

- `status` 'touched' | 'converted' | 'expired' | 'rejected': What became of a referral touch. `Touched` is an attribution waiting for a first payment inside the window; `Converted` has one and may keep earning for the commission period; `Expired` ran out of window; `Rejected` was refused after the fact (a self-referral found later, an abuse review).
- `affiliate_id` string, uuid
- `since` string, date-time
- `page` integer
- `per_page` integer
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `limit` integer

## Response `200`

The page.

- object
  - `data` ReferralResource[], required: The items on this page.
    - `id` string, required: The referral's id.
    - `project_id` string, required: The project the programme belongs to.
    - `program_id` string, required: The programme the affiliate earns under.
    - `affiliate_id` string, required: The affiliate who referred the friend.
    - `member_id` string, required: The friend, as the members endpoints list them.
    - `source` string, required: How the friend arrived: `portal_link`, `connector_link` or `code_at_checkout`.
    - `connector` string, nullable, required: The connector whose link they came through, such as a bot's deep link; null for the portal or a typed code.
    - `status` string, required: `touched` (arrived, not yet paid), `converted` (first payment settled), `expired` (the attribution window passed) or `rejected`.
    - `touched_at` string, required: When the friend arrived, ISO 8601.
    - `expires_at` string, required: When the attribution lapses unless they pay, ISO 8601.
    - `converted_at` string, nullable, required: When their first payment settled, ISO 8601; null until then.
    - `converted_subscription_id` string, nullable, required: The purchase that converted them; null until then.
    - `commission_ends_at` string, nullable, required: On a cash programme with a period, when the affiliate stops earning on this friend, ISO 8601; null for life, for a first-payment-only commission, or before conversion.
    - `created_at` string, nullable, required: When the row was written, ISO 8601.
  - `links` object, required: Links to the first, last, previous and next pages.
    - `first` string, nullable, required: The first page's URL.
    - `last` string, nullable, required: The last page's URL.
    - `prev` string, nullable, required: The previous page's URL; null on the first page.
    - `next` string, nullable, required: The next page's URL; null on the last page.
  - `meta` object, required: The paging counters for this page.
    - `current_page` integer, required: The page returned, 1-indexed.
    - `from` integer, nullable, required: The 1-indexed position of this page's first item across every page; null when the page is empty.
    - `last_page` integer, required: How many pages there are.
    - `links` object[], required: Generated paginator links.
      - `url` string, nullable, required: The page's URL; null for the ellipsis and the disabled arrows.
      - `label` string, required: The link's label: a page number, the previous or next arrow, or an ellipsis.
      - `active` boolean, required: Whether this link is the current page.
    - `path` string, nullable, required: Base path for paginator generated URLs.
    - `per_page` integer, required: Number of items shown per page.
    - `to` integer, nullable, required: Number of the last item in the slice.
    - `total` integer, required: Total number of items being paginated.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `422`: `VALIDATION_FAILED`: the payload broke a rule, and `error.fields` maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with `error.message` saying why and no `fields`.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)