Skip to main content
GET
Get reward recipients

Query Parameters

rewardId
string
required

The reward ID to get recipients for (MongoDB ObjectId)

startDate
string
endDate
string
skip
integer
default:0

Number of records to skip

Required range: x >= 0
limit
integer
default:10

Number of records to return (max 50)

Required range: 1 <= x <= 100
sortBy
enum<string>
default:lastReceived

Field to sort by

Available options:
name,
quantity,
lastReceived
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Successful response

data
object[]
required
totalCount
number
required
rewardType
string | null
required
drawDate
string | null
required
isDrawn
boolean
required
distributionType
string | null
required
winningStats
object | null
required