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 |
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 | |
| Referrals | ReferralCountsResponse | Yes | |
| Commissions | ReferralCommissionTotalsResponse | Yes | |
| DeliveryMode | string | Yes | |
| VoucherClaimDays | unknown | Yes |
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.