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

# Get a referral

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

## Request

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

One referral: how the friend arrived (`source` is `portal_link`, `connector_link` or `code_at_checkout`; `connector` names the bot's platform on a connector link), whether their first payment settled, and `commission_ends_at`, the instant the affiliate stops earning on them on a programme with a period.

## Path parameters

- `project` string, uuid, required
- `referral` string, uuid, required

## Response `200`

The referral.

- object
  - `data` ReferralResource, required: A referral: a friend who arrived through an affiliate's link or code, whether their first payment settled, and until when the affiliate earns on them.
    - `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.

## 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.
- `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)