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 [
]
Unique identifier for RewardType
JSON string containing metadata, actions, and functions associated with the reward.
Title of the reward type.
The date and time when the reward type was created.
URL of the thumbnail for the reward type.
Name of the reward type.
Category of the reward type.
Boolean to specify if the rewardType can reeemed once.
Detailed description of the reward type.
[
{
"category": "Digital Goods",
"description": "This reward gives you access to premium features for one month.",
"singleUse": true,
"title": "One Month Premium Subscription",
"data": "{\"validity\": \"30 days\", \"features\": [\"no ads\", \"exclusive content\"]}",
"id": "RdTH7lpED",
"name": "Premium Subscription",
"thumbnail": "https://example.com/thumbnail.png",
"createdAt": "2023-10-23T10:00:00Z"
},
{
"title": "$50 Gift Card",
"data": "{\"validity\": \"No expiration\", \"features\": [\"can be used multiple times\"]}",
"id": "RgyXrhXZy",
"name": "Gift Card",
"createdAt": "2023-11-01T12:30:00Z",
"thumbnail": "https://example.com/thumbnail.png",
"category": "Physical Goods",
"description": "This reward provides a $50 gift card for use on our platform.",
"singleUse": false
}
]
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Internal Server Error"
}