GET
/api/v2/users/{userId}/referrals/summaryReturns invite, level progress, referral counts, commission totals, and payout mode.
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (path) | integer (int32) | Yes | |
| programId (query) | string (uuid) | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Enabled | boolean | Yes | |
| Provider | string | Yes | |
| ReferralCode | string | Yes | |
| ReferralPath | string | Yes | |
| InviteOffer | object | Yes | |
| CurrentLevel | object | Yes | |
| NextLevel | object | Yes | |
| Levels | array of ReferralLevelResponse | Yes | |
| Progress | ReferralMetricProgressResponse | Yes | Progress towards the next visible level. Basis/CurrentValue/NextThreshold/Remaining are the legacy single-metric view (qualified referrals); the per-condition fields are null when the next level does not set that condition and 0 when it is already met. |
| Referrals | ReferralCountsResponse | Yes | |
| Rewards | ReferralRewardTotalsResponse | Yes | Reward totals for the current user, by delivery stage. |
| Offer | object | Yes | |
| Terms | object | Yes | |
| DeliveryMode | string | Yes | |
| MinimumCreditAmount | unknown | Yes | |
| AccumulatedTowardsCredit | unknown | Yes | |
| ProgramId | string (uuid) | No | |
| ProgramName | string | No | |
| CanInvite | boolean | No | |
| AssignedLevel | boolean | No | |
| ProgramDescription | string | No | |
| ParticipationEligibility | object | No |
Example request
curl -X GET "https://{base_url}/api/v2/users/{userId}/referrals/summary" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.