List your referrals

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.

Requires ability

account:read

The token must hold this ability, or the call is refused with 403.

MCP tool

list_partner_referrals

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Query Parameters

status?PartnerReferralStatus

Keep only referrals in this state: signed_up, converted, under_review, expired or rejected.

Value in

"signed_up"
"converted"
"under_review"
"expired"
"rejected"

page?integer

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

Range1 <= value

Default1

per_page?integer

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

Range1 <= value <= 100

Default25

sort_by?string

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

Default"created_at"

sort_direction?string

asc or desc. Defaults to desc.

Default"desc"

Value in

"asc"
"desc"

limit?integer

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Range1 <= value <= 100

Responses

200OKapplication/json

The page.

data*array<>

The items on this page.

links*

Links to the first, last, previous and next pages.

meta*

The paging counters for this page.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

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.

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

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.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/me/partner/referrals"

{  "data": [    {      "id": "3c4d5e6f-7081-4a2b-9c3d-4e5f6a7b8c9d",      "referred_name": "Grace Hopper",      "source": "link",      "status": "converted",      "plan": "starter",      "signed_up_at": "2026-10-08T11:00:00+00:00",      "expires_at": "2027-04-06T11:00:00+00:00",      "converted_at": "2026-10-09T14:20:00+00:00",      "commission_percent": "15.00",      "commission_ends_at": "2027-10-09T14:20:00+00:00",      "created_at": "2026-10-08T11:00:00+00:00"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 1,    "total": 0  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: PartnerReferralResource[];  links: Links;  meta: Meta;}export interface PartnerReferralResource {  id: string;  referred_name: string | null;  source: string;  status: string;  plan: string | null;  signed_up_at: string;  expires_at: string;  converted_at: string | null;  commission_percent: string | null;  commission_ends_at: string | null;  created_at: string | null;}export interface Links {  first: string | null;  last: string | null;  prev: string | null;  next: string | null;}export interface Meta {  current_page: number;  from: number | null;  last_page: number;  links: Link[];  path: string | null;  per_page: number;  to: number | null;  total: number;}export interface Link {  url: string | null;  label: string;  active: boolean;}

List your referrals

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Authorization

Query Parameters

Responses