Referral Program

List referrals

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.

get/v1/projects/{project}/referrals

Request

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

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

Keep only referrals in this state: touched (the friend arrived, not yet paid), converted (their first payment settled), expired (the attribution window passed) or rejected.

affiliate_idstring uuid

Keep only the referrals one affiliate brought in.

sincestring date-time

Keep only referrals whose friend arrived on or after this instant, ISO 8601, so a report can page what happened since its last run.

pageinteger

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.

per_pageinteger

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

sort_bystring

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

sort_direction'asc' | 'desc'

asc or desc. Defaults to desc.

limitinteger

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

Response

The page.

Changes

No recorded changes to this operation across all 1 revision of this API.