GET
/api/v2/referrals/overviewGET /api/v2/referrals/overview
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| programId (query) | string (uuid) | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Program | ReferralProgramResponse | Yes | |
| TotalRelationships | unknown | Yes | |
| QualifiedReferrals | unknown | Yes | |
| QualifyingTopupVolume | unknown | Yes | |
| PendingLiability | unknown | Yes | |
| PaidRewards | unknown | Yes | |
| WelcomePaid | unknown | Yes | |
| ReservedExposure | unknown | Yes | |
| ExposureLimit | unknown | Yes | |
| CreditsPaid | unknown | Yes | |
| FailedCredits | unknown | Yes | |
| ExcludedEvents | unknown | Yes | |
| Currency | string | Yes | |
| TopupRewardLimits | object | No | |
| UnboundedCommitmentCount | unknown | No | |
| ExposureAccountingDescription | string | No |
Example request
curl -X GET "https://{base_url}/api/v2/referrals/overview" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.