Get all rewardTypes

GET 
/rewardTypes

Get all rewardTypes

Request

Query Parameters

name string

Search for rewardTypes by name

startDate date-time

Search by start date

endDate date-time

Search by end date

page integer

Possible values: >= 1

Default value: 1

Specify the page number for pagination (default is 1).

limit integer

Default value: 10

Specify the number of rewardTypes per page (default is 10, 0 gets all results).

sortBy string

Possible values: [createdAt, name, category]

Field to order the results by, default is 'createdAt'.

sortOrder string

Possible values: [asc, desc]

Default value: desc

'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses

200

rewardTypes retrieved successfully

application/json

Schema

Schema

• Array [

createdAt date-time

The date and time when the reward type was created.

data stringrequired

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

title stringrequired

Title of the reward type.

singleUse boolean

Boolean to specify if the rewardType can reeemed once.

name stringrequired

Name of the reward type.

id rewardTypeId (string)

Unique identifier for RewardType

category stringrequired

Category of the reward type.

description string

Detailed description of the reward type.

thumbnail stringnullable

URL of the thumbnail for the reward type.

• ]

Example (from schema)

[
  {
    "data": "{\"validity\": \"30 days\", \"features\": [\"no ads\", \"exclusive content\"]}",
    "title": "One Month Premium Subscription",
    "createdAt": "2023-10-23T10:00:00Z",
    "thumbnail": "https://example.com/thumbnail.png",
    "description": "This reward gives you access to premium features for one month.",
    "category": "Digital Goods",
    "singleUse": true,
    "id": "RdTH7lpED",
    "name": "Premium Subscription"
  },
  {
    "thumbnail": "https://example.com/thumbnail.png",
    "description": "This reward provides a $50 gift card for use on our platform.",
    "category": "Physical Goods",
    "name": "Gift Card",
    "id": "RgyXrhXZy",
    "singleUse": false,
    "title": "$50 Gift Card",
    "data": "{\"validity\": \"No expiration\", \"features\": [\"can be used multiple times\"]}",
    "createdAt": "2023-11-01T12:30:00Z"
  }
]

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

Loading...