GET
/api/v2/admin/referrals/overviewGET /api/v2/admin/referrals/overview
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| companyId (query) | unknown | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Program | ReferralProgramResponse | Yes | |
| TotalRelationships | unknown | Yes | |
| SuccessfulReferrals | unknown | Yes | |
| QualifyingTopupVolume | unknown | Yes | |
| PendingLiability | unknown | Yes | |
| PaidCommission | unknown | Yes | |
| Currency | string | Yes |
Example request
curl -X GET "https://{base_url}/api/v2/admin/referrals/overview" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.