Get a reward by ID

GET 
/reward/:rewardId

Get a reward by ID

Request

Path Parameters

rewardId rewardIdrequired

The unique identifier for the reward

Responses

200

Reward retrieved successfully

application/json

Schema

Schema

data stringnullable

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

userRewardsLimit integer

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

thumbnail urinullable

Optional URL for the reward's thumbnail image.

expiresAt date-timenullable

Expiration date for special rewards

rewardTypeId rewardTypeId (string)required

Unique identifier for RewardType

myUserRewardCount integer

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

rankOrder integer

The order in which the reward should be displayed

name rewardName (string)required

Possible values: <= 32 characters

Name of the reward

description string

Detailed description of the reward

createdAt date-time

Time representation of entity creation

requiredPoints integer

Possible values: <= 1000000

Points required to claim the reward

projectId stringrequired

ID of the project associated with the reward

maxClaims integernullable

Maximum number of times this reward can be redeemed.

userRewardCount integer

Number of times this reward has been redeemed.

id rewardId (string)

Unique identifier for Reward

Example (from schema)

{
  "data": "{\"criteria\": \"complete_all_adventure_quests\", \"icon\": \"explorer_badge_icon.png\"}",
  "userRewardsLimit": 3,
  "thumbnail": "https://file.playmakers.co/r15Y7T4sM/r15Y7T4sM_thumbnail.png",
  "expiresAt": "2025-01-01T09:00:00.00Z",
  "rewardTypeId": "R3b19Z1n",
  "myUserRewardCount": 2,
  "rankOrder": 1,
  "name": "Amazon gift card",
  "description": "{\"pre\":[\"Are you sure you want to claim this reward?\"],\"short\":\"A 20$ gift card for my followers\",\"post\":[\"Your reward has been redeemed successfully!\"]}",
  "createdAt": "2024-01-01T09:00:00.00Z",
  "requiredPoints": 10,
  "projectId": "pGdouyKfY",
  "maxClaims": null,
  "userRewardCount": 1,
  "id": "r3b19Z1n"
}

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...