Get a reward by ID

GET 
https://api.playmakers.co/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

name rewardName (string)required

Possible values: <= 32 characters

Name of the reward

userRewardCount integer

Number of times this reward has been redeemed.

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.

expiresAt date-timenullable

Expiration date for special rewards

userRewardsLimit integer

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

rewardTypeId rewardTypeId (string)required

Unique identifier for RewardType

createdAt date-time

Time representation of entity creation

myUserRewardCount integer

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

data stringnullable

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

description stringrequired

Detailed description of the reward

requiredPoints integer

Possible values: <= 1000000

Points required to claim the reward

rankOrder integer

The order in which the reward should be displayed

maxClaims integernullable

Maximum number of times this reward can be redeemed.

Example (from schema)

{
  "name": "Amazon gift card",
  "userRewardCount": 1,
  "projectId": "pGdouyKfY",
  "id": "r3b19Z1n",
  "thumbnail": "https://file.playmakers.co/r15Y7T4sM/r15Y7T4sM_thumbnail.png",
  "expiresAt": "2025-01-01T09:00:00.00Z",
  "userRewardsLimit": 3,
  "rewardTypeId": "R3b19Z1n",
  "createdAt": "2024-01-01T09:00:00.00Z",
  "myUserRewardCount": 2,
  "data": "{\"criteria\": \"complete_all_adventure_quests\", \"icon\": \"explorer_badge_icon.png\"}",
  "description": "By completing the quest you're awarded with a shimmery golden badge",
  "requiredPoints": 10,
  "rankOrder": 1,
  "maxClaims": null
}

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"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.playmakers.co/reward/:rewardId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://api.playmakers.co

Auth

Bearer Token

Parameters

rewardId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!