Rewards API
Retrieve rewards claimed by a participant within an engagement session.
Authentication: Public endpoint. Pass
engagement_id and session_id as query parameters. No API key required.Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /public/rewards/claimed | Get all rewards claimed by a session |
Get Claimed Rewards
Returns all rewards that have been claimed by a participant in the given engagement. Rewards are claimed automatically through on-completion actions (e.g., completing a quiz awards a coupon).
curl -X GET "https://YOUR_API_DOMAIN/api/v1/public/rewards/claimed?engagement_id=550e8400-e29b-41d4-a716-446655440000&session_id=sess_abc123"Response
{
"rewards": [
{
"reward_id": "rwd_001",
"name": "20% Off Your Next Order",
"type": "coupon",
"code": "SAVE20ABC",
"display_type": "coupon",
"claimed_at": "2026-04-10T14:30:00Z",
"expires_at": "2026-05-10T23:59:59Z",
"metadata": {
"discount_percent": 20,
"min_order_value": 25.00
}
},
{
"reward_id": "rwd_002",
"name": "$10 Gift Card",
"type": "voucher",
"code": "GC10-XYZ-789",
"display_type": "gift_card",
"claimed_at": "2026-04-10T14:35:00Z",
"expires_at": null,
"metadata": {
"value": 10.00,
"currency": "USD"
}
}
]
}Reward Types
Rewards can be one of several types, each with different display styles in the runtime UI:
| Type | Display | Description |
|---|---|---|
coupon | Coupon card | Discount code with optional expiry and conditions |
voucher | Voucher card | Fixed-value voucher or credit |
physical | Gift card | Physical item requiring fulfillment |
digital | Simple card | Digital download, access code, or membership |
points_multiplier | Simple card | Temporary points multiplier (e.g., 2x points for 24 hours) |