Get a rewardType by ID

GET 
/rewardType/:rewardTypeId

Get a rewardType by ID

Request

Path Parameters

rewardTypeId rewardTypeIdrequired

The unique identifier for the rewardType

Responses

200

rewardType retrieved successfully

application/json

Schema

Schema

singleUse boolean

Boolean to specify if the rewardType can reeemed once.

title stringrequired

Title of the reward type.

category stringrequired

Category of the reward type.

thumbnail stringnullable

URL of the thumbnail for the reward type.

createdAt date-time

The date and time when the reward type was created.

description string

Detailed description of the reward type.

name stringrequired

Name of the reward type.

id rewardTypeId (string)

Unique identifier for RewardType

data stringrequired

JSON string containing metadata, actions, and functions associated with the reward.

Example (from schema)

{
  "singleUse": "true",
  "title": "One Month Premium Subscription",
  "category": "Digital Goods",
  "thumbnail": "https://example.com/thumbnail.png",
  "createdAt": "2023-10-23T10:00:00Z",
  "description": "This reward gives you access to premium features for one month.",
  "name": "Premium Subscription",
  "id": "R3b19Z1n",
  "data": "{\"validity\": \"30 days\", \"features\": [\"no ads\", \"exclusive content\"]}"
}

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