Referral Program

List affiliates

curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/referral-affiliates?status=approved&per_page=25" \
  -H "Authorization: Bearer sbt_..."

Pages the programme's affiliates, newest first. status is pending, approved or suspended; member_id finds the affiliate row of one member. A list row never carries balances: read one affiliate for what they are owed.

get/v1/projects/{project}/referral-affiliates

Request

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Query parameters

status'pending' | 'approved' | 'suspended'

Where a member stands in a project's Referral Program. Pending exists only for programmes that require approval; a suspended affiliate keeps their code and their balance but attributes and earns nothing until the creator approves them again.

Keep only affiliates in this standing: pending (awaiting the creator's approval), approved (their code counts) or suspended (their code no longer counts; what they earned stays).

member_idstring uuid

Find one member's affiliate row by their member id, as the members endpoints list them.

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, without balances.

Example response

{
  "data": [
    {
      "id": "0b1c2d3e-4f50-4617-8a9b-0c1d2e3f4a5b",
      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
      "program_id": "6e2a7a4f-3b8c-4c21-9f6d-2a3b4c5d6e7f",
      "member_id": "a1b2c3d4-e5f6-4718-8a9b-0c1d2e3f4a5b",
      "code": "ADA2026",
      "status": "approved",
      "joined_at": "2026-10-02T11:05:00+00:00",
      "approved_at": "2026-10-02T11:05:00+00:00",
      "created_at": "2026-10-02T11:05:00+00:00",
      "updated_at": "2026-10-08T16:41:11+00:00"
    }
  ]
}

Changes

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