Skip to main content
GET
Scope required: rewards.issue
This endpoint returns all active partner-initiated campaigns for a given merchant. Only campaigns created through the Partner API are returned.

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
Campaign ID
name
string
Campaign name
objective
string
Campaign objective
start_at
datetime
Campaign start date (ISO8601)
end_at
datetime
Campaign end date (ISO8601)
redeemable_from
datetime
Reward redemption start date (ISO8601)
redeemable_to
datetime
Reward redemption end date (ISO8601)
time_zone
string
Campaign time zone
fine_print
string
Terms and conditions
variants
array
Campaign variants
pagination
hash
Pagination information