Get all rewards by projectId

GET 
/rewards/by/project/:projectId

Get all rewards by projectId

Request

Path Parameters

projectId projectIdrequired

The unique identifier for the project

Query Parameters

startDate date-time

Search by start date

endDate date-time

Search by end date

page integer

Possible values: >= 1

Default value: 1

Specify the page number for pagination (default is 1).

limit integer

Default value: 10

Specify the number of projects per page (default is 10, 0 gets all results).

sortBy string

Possible values: [createdAt, claimedAt, requiredPoints, expiresAt, userRewardCount, rankOrder]

Field to order the results by (e.g., 'createdAt', 'requiredPoints'). Default is 'createdAt'.

sortOrder string

Possible values: [asc, desc]

Default value: desc

'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses

200

Rewards retrieved successfully

application/json

Schema

Schema

• Array [

userRewardCount integer

Number of times this reward has been redeemed.

expiresAt date-timenullable

Expiration date for special rewards

name rewardName (string)required

Possible values: <= 32 characters

Name of the reward

maxClaims integernullable

Maximum number of times this reward can be redeemed.

createdAt date-time

Time representation of entity creation

rewardTypeId rewardTypeId (string)required

Unique identifier for RewardType

description stringrequired

Detailed description of the reward

rankOrder integer

The order in which the reward should be displayed

data stringnullable

Additional JSON metadata for triggers, actions or general easy-access data

requiredPoints integer

Possible values: <= 1000000

Points required to claim the reward

myUserRewardCount integer

Number of times this reward has been redeemed by the current user.

projectId stringrequired

ID of the project associated with the reward

id rewardId (string)

Unique identifier for Reward

thumbnail urinullable

Optional URL for the reward's thumbnail image.

userRewardsLimit integer

Maximum allowed number of times for the reward to be redeemed by a single user

• ]

Example (from schema)

[
  {
    "thumbnail": "https://file.playmakers.co/rbSLt8c7w/rbSLt8c7w_thumbnail.png",
    "id": "rbSLt8c7w",
    "projectId": "pGdouyKfY",
    "myUserRewardCount": 1,
    "requiredPoints": null,
    "data": "{\"criteria\": \"win_10_strategic_games\", \"icon\": \"strategist_badge_icon.png\"}",
    "description": "By devising a winning strategy, you've earned this prestigious badge.",
    "rewardTypeId": "RCFwQSOkf",
    "createdAt": "2024-02-15T12:30:00.00Z",
    "maxClaims": null,
    "name": "Achievement Unlocked: Master Strategist",
    "userRewardCount": 3,
    "expiresAt": "2026-02-15T12:30:00.00Z"
  },
  {
    "data": "{\"criteria\": \"participate_in_20_discussions\", \"icon\": \"social_butterfly_badge_icon.png\"}",
    "requiredPoints": null,
    "thumbnail": "https://file.playmakers.co/r1diPhaVh/r1diPhaVh_thumbnail.png",
    "myUserRewardCount": 0,
    "id": "r1diPhaVh",
    "projectId": "pGdouyKfY",
    "maxClaims": null,
    "userRewardCount": 1,
    "expiresAt": "2025-03-10T15:45:00.00Z",
    "name": "Achievement Unlocked: Social Butterfly",
    "rewardTypeId": "RCFwQSOkf",
    "description": "You've engaged with the community by participating in 20 discussions, earning this vibrant badge.",
    "createdAt": "2024-03-10T15:45:00.00Z"
  }
]

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

Loading...