GET/api/v2/users/{userId}/referrals/friends

Referred friends with pseudonyms ("user-XXXXX"), stages and per-friend earnings. Never exposes the friend's identity.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
userId (path)integer (int32)Yes
programId (query)string (uuid)No
page (query)unknownNo
pageSize (query)unknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
AliasstringYes
StagestringYes
AttributedAtstring (date-time)Yes
KycCompletedAtstring (date-time)Yes
FirstCardAtstring (date-time)Yes
FirstTopupAtstring (date-time)Yes
QualifiedAtstring (date-time)Yes
EarningUntilstring (date-time)Yes
EarnedAmountunknownYes
CurrencystringYes
RecipientNamestringYes

Example request

curl -X GET "https://{base_url}/api/v2/users/{userId}/referrals/friends" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.