---
title: "List your referrals"
method: GET
path: "/v1/me/partner/referrals"
tags: ["Partner Program"]
---

# List your referrals

`GET /v1/me/partner/referrals`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/me/partner/referrals`
- Auth: HTTP bearer

```bash
curl "https://api.subscriby.net/v1/me/partner/referrals?status=converted&per_page=25" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
```

Pages the creators you brought to Subscriby, newest first. `status` is `signed_up`, `converted`, `under_review`, `expired` or `rejected`. Each row names the referred creator by display name alone: they are a Subscriby customer, not yours, so their email and id never appear. An application still under review has no referrals and answers an empty page.

## Query parameters

- `status` 'signed_up' | 'converted' | 'under_review' | 'expired' | 'rejected': What became of a referred creator's sign-up. `SignedUp` waits for a first paid Starter or Growth invoice inside the conversion window; `Converted` has one and earns for the commission period; `UnderReview` converted on a card that matches the partner's and earns nothing until the owner clears or rejects it; `Expired` ran out of window; `Rejected` was refused after review.
- `page` integer
- `per_page` integer
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `limit` integer

## Response `200`

The page.

- object
  - `data` PartnerReferralResource[], required: The items on this page.
    - `id` string, required: The referral's id.
    - `referred_name` string, nullable, required: The referred creator's display name; null when the account is gone. Their email and id are never returned.
    - `source` string, required: How they arrived: `link` (the web link's cookie), `code_at_signup` (the code typed on the sign-up form) or `bot_deep_link` (a connector's deep link).
    - `status` string, required: `signed_up` (inside the conversion window, no paid plan yet), `converted` (first Starter or Growth invoice paid, earning), `under_review` (held by Subscriby for a fraud signal), `expired` (the window passed unpaid) or `rejected` (rejected after review).
    - `plan` string, nullable, required: The platform plan they converted on, `starter` or `growth`; null until converted.
    - `signed_up_at` string, required: When they signed up, ISO 8601.
    - `expires_at` string, required: When the conversion window closes unless they pay, ISO 8601.
    - `converted_at` string, nullable, required: When their first paid invoice settled, ISO 8601; null until then.
    - `commission_percent` string, nullable, required: The rate locked onto this referral at conversion, as a decimal string with two places; null until converted.
    - `commission_ends_at` string, nullable, required: When the partner stops earning on this creator, ISO 8601; null until converted.
    - `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.
- `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)