v1
latestOpenAPI 3.0.12026-07-24210349345.4 KBAssigned Prizes
This endpoint allows you to query prizes that have been assigned to players after they have completed a campaign. These assigned prizes may include unique prize codes that players can redeem. You can use this endpoint to fetch all assigned prizes for a specific campaign, additionally you can filter by a specific prize or player information.
Path parameters
The ID of the campaign you want to retrieve prize winners from.
Query parameters
Filter the results to only show winners of a specific prize.
Filter results to only show prizes assigned to a specific player ID.
Filter results by a specific player's email address.
Filter results by the Integration Unique ID of the player.
The number of records to skip for pagination. Defaults to 0.
The maximum number of records to return. Defaults to 15, Max 200.
Response
200
Example response
{
"data": [
{
"id": "assigned_prize_01JXEBFB...",
"prizeId": "prize_01JXEBFB...",
"prizeCode": "ABC-123-XYZ",
"prizeTitle": "10% Discount",
"player": {
"id": "player_01JXEBFB...",
"email": "jane.doe@example.com",
"fullName": "Jane Doe",
"leaderboardName": "JaneD"
},
"createdAt": "2025-07-15T10:00:00.000000Z"
}
],
"meta": {
"total": 50,
"perPage": 10,
"currentPage": 1,
"lastPage": 5,
"from": 1,
"to": 10
}
}