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

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

Response

string
Campaign ID
string
Campaign name
string
Campaign objective
datetime
Campaign start date (ISO8601)
datetime
Campaign end date (ISO8601)
datetime
Reward redemption start date (ISO8601)
datetime
Reward redemption end date (ISO8601)
string
Campaign time zone
string
Terms and conditions
array
Campaign variants
hash
Pagination information