Get all rewardTypes
GET/rewardTypes
Get all rewardTypes
Request
Query Parameters
Search for rewardTypes by name
Search by start date
Search by end date
Possible values: >= 1
Default value: 1
Specify the page number for pagination (default is 1).
Default value: 10
Specify the number of rewardTypes per page (default is 10, 0 gets all results).
Possible values: [createdAt
, name
, category
]
Field to order the results by, default is 'createdAt'.
Possible values: [asc
, desc
]
Default value: desc
'asc' for ascending or 'desc' for descending order. Default is 'desc'.
Responses
- 200
- 500
rewardTypes retrieved successfully
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Boolean to specify if the rewardType can reeemed once.
Title of the reward type.
Category of the reward type.
URL of the thumbnail for the reward type.
The date and time when the reward type was created.
Detailed description of the reward type.
Name of the reward type.
Unique identifier for RewardType
JSON string containing metadata, actions, and functions associated with the reward.
[
{
"singleUse": true,
"title": "One Month Premium Subscription",
"category": "Digital Goods",
"thumbnail": "https://example.com/thumbnail.png",
"createdAt": "2023-10-23T10:00:00Z",
"name": "Premium Subscription",
"id": "RdTH7lpED",
"description": "This reward gives you access to premium features for one month.",
"data": "{\"validity\": \"30 days\", \"features\": [\"no ads\", \"exclusive content\"]}"
},
{
"data": "{\"validity\": \"No expiration\", \"features\": [\"can be used multiple times\"]}",
"description": "This reward provides a $50 gift card for use on our platform.",
"id": "RgyXrhXZy",
"name": "Gift Card",
"createdAt": "2023-11-01T12:30:00Z",
"thumbnail": "https://example.com/thumbnail.png",
"category": "Physical Goods",
"title": "$50 Gift Card",
"singleUse": false
}
]
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Internal Server Error"
}