TriportRPC
DashboardDocs

GET /v1/referrals/invitees — List referred users

GEThttps://api.triport.io/v1/referrals/invitees?limit=50&offset=0

Returns the users who signed up under your referral code, with how much each has paid.

——Console tier (standard per-session RPS with burst)

Lists the accounts that registered through your referral code. This is a read-side, console-only endpoint backing the Invitees table in the referral dashboard — use it to see who you've referred and how much revenue each of them has driven.

Each row identifies one invitee by their account user_id, their public display_name, the time they signed up under your code (signed_at), and the lifetime amount they have paid in micro-units (total_paid_micro). For privacy, no email or other PII is returned — only the public display name.

Results are returned newest-relevant first and are paginated with limit and offset. There is no total-count field; request successive pages until you receive fewer than limit rows.

Parameters

Query parameters

limitintegeroptional
Max rows to return. Valid range 1–200. Defaults to 50. Values outside the range are ignored and the default is used.
offsetintegeroptional
Number of rows to skip, for pagination. Must be >= 0. Defaults to 0.

Response

When you have no invitees, items is an empty array ({"items": []}), never null.

itemsarray
List of invitee rows. Empty array when there are none.
items[].user_idstring (UUID)
The invitee's account identifier.
items[].display_namestring
The invitee's public display name.
items[].signed_atstring (RFC 3339 timestamp)
When the invitee signed up under your referral code.
items[].total_paid_microinteger
Lifetime amount the invitee has paid, in micro-units (1,000,000 = 1 unit).

Errors

CodeMeaningWhen it happens
401unauthenticatedNo valid console session cookie was presented.
500internalAn unexpected server-side error occurred while loading invitees.

Errors use the shared error envelope { "error": "<tag>" }. See errors.md for the full envelope and handling guidance.

Examples

JavaScript (fetch)

const res = await fetch(
  "https://api.triport.io/v1/referrals/invitees?limit=50&offset=0",
  {
    credentials: "include",
    headers: { "Content-Type": "application/json" },
  }
);
if (!res.ok) throw new Error((await res.json()).error ?? `HTTP ${res.status}`);
const { items } = await res.json();
console.log(`${items.length} invitees`);

TypeScript SDK (@triport/sdk)

import { TriportClient } from "@triport/sdk";


const client = new TriportClient(); // uses the active console session
const { items } = await client.referrals.listInvitees({ limit: 50, offset: 0 });


for (const row of items) {
  console.log(row.display_name, row.total_paid_micro);
}

Python (triport-sdk)

from triport import TriportClient


client = TriportClient()  # uses the active console session
result = client.referrals.list_invitees(limit=50, offset=0)


for row in result["items"]:
    print(row["display_name"], row["total_paid_micro"])

Notes

  • Pagination: there is no total count. Keep increasing offset by limit until a page returns fewer than limit rows.
  • Micro-units: divide total_paid_micro by 1,000,000 to display a human-readable amount.
  • No PII: email and other personal data are intentionally excluded; only display_name is exposed.
  • Related endpoints: GET /v1/referrals/me for your referral overview and balance, and GET /v1/referrals/rewards for the per-payment reward ledger.