Skip to main content
GET
Scope required: rewards.issue
This endpoint returns all published reward templates for a given merchant. Reward templates define the type of reward that can be issued through a campaign. Use these templates when creating campaigns to specify what reward each variant will offer.

Parameters

merchant_id
string
required
Merchant ID
page
integer
The current page of paginated resources.
  • Default: 1.
per_page
integer
Number of records to be returned per API request.
  • Default: 10
  • Minimum: 1
  • Maximum: 100

Response

id
string
Reward template ID
name
string
Template name
type
string
Reward type
subtype
string
Reward subtype
description
string
Short description of the reward
fine_print
string
Terms and conditions
discount
hash
Discount details
redemption_venue
string
Where the reward can be redeemed
images
hash
Image URLs for the reward template
pagination
hash
Pagination information