Get all rewards by projectId
GET/rewards/by/project/:projectId
Get all rewards by projectId
Request
Path Parameters
The unique identifier for the project
Query Parameters
Search by start date
Search by end date
Filter by category(e.g. manual, webhook, etc.)
Possible values: >= 1
Default value: 1
Specify the page number for pagination (default is 1).
Default value: 10
Specify the number of projects per page (default is 10, 0 gets all results).
Possible values: [createdAt
, requiredPoints
, expiresAt
, userRewardCount
, rankOrder
]
Field to order the results by (e.g., 'createdAt', 'requiredPoints'). Default is 'createdAt'.
Possible values: [asc
, desc
]
Default value: desc
'asc' for ascending or 'desc' for descending order. Default is 'desc'.
Responses
- 200
- 403
- 404
- 500
Rewards retrieved successfully
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Number of times this reward has been redeemed.
Expiration date for special rewards
Number of times this reward has been redeemed by the current user.
Additional JSON metadata for triggers, actions or general easy-access data
Maximum allowed number of times for the reward to be redeemed by a single user
Possible values: <= 1000000
Points required to claim the reward
Detailed description of the reward
The order in which the reward should be displayed
Optional URL for the reward's thumbnail image.
Unique identifier for RewardType
ID of the project associated with the reward
Time representation of entity creation
Maximum number of times this reward can be redeemed.
Possible values: <= 32 characters
Name of the reward
Unique identifier for Reward
[
{
"maxClaims": null,
"name": "Achievement Unlocked: Master Strategist",
"id": "rbSLt8c7w",
"createdAt": "2024-02-15T12:30:00.00Z",
"projectId": "pGdouyKfY",
"rewardTypeId": "RCFwQSOkf",
"thumbnail": "https://file.playmakers.co/rbSLt8c7w/rbSLt8c7w_thumbnail.png",
"expiresAt": "2026-02-15T12:30:00.00Z",
"userRewardCount": 3,
"description": "By devising a winning strategy, you've earned this prestigious badge.",
"requiredPoints": null,
"myUserRewardCount": 1,
"data": "{\"criteria\": \"win_10_strategic_games\", \"icon\": \"strategist_badge_icon.png\"}"
},
{
"expiresAt": "2025-03-10T15:45:00.00Z",
"userRewardCount": 1,
"data": "{\"criteria\": \"participate_in_20_discussions\", \"icon\": \"social_butterfly_badge_icon.png\"}",
"myUserRewardCount": 0,
"requiredPoints": null,
"description": "You've engaged with the community by participating in 20 discussions, earning this vibrant badge.",
"createdAt": "2024-03-10T15:45:00.00Z",
"thumbnail": "https://file.playmakers.co/r1diPhaVh/r1diPhaVh_thumbnail.png",
"rewardTypeId": "RCFwQSOkf",
"projectId": "pGdouyKfY",
"id": "r1diPhaVh",
"name": "Achievement Unlocked: Social Butterfly",
"maxClaims": null
}
]
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Forbidden access"
}
NotFound
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "A mandatory item was not found"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Internal Server Error"
}