GET
/api/v2/referrals/rewardsReward ledger across the company's programs.
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| programId (query) | string (uuid) | No | |
| status (query) | string | No | |
| beneficiaryRole (query) | string | No | |
| eventType (query) | string | No | |
| page (query) | unknown | No | |
| pageSize (query) | unknown | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Reward | ReferralRewardResponse | Yes | One reward ledger row. Stage: PENDING, READY, CREDITING, PAID, FAILED. |
| BeneficiaryUserId | unknown | Yes | |
| BeneficiaryEmail | string | Yes | |
| SubjectUserId | unknown | Yes | |
| SubjectEmail | string | Yes |
Example request
curl -X GET "https://{base_url}/api/v2/referrals/rewards" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.