Jump to Content
Home
API Reference
v1.0
v2.0
API Reference
API Reference
API Reference
v2.0
API Reference
Structure
Search
All
Pages
Start typing to searchβ¦
JUMP TO
BASE URL
Introduction
API Limits
Authentication
Obtain API keys
Campaigns
The Campaign object
Structure
Example
List all campaigns
get
Retrieve a campaign
get
Search campaigns
Relations
post
Select Fields
post
Filtering
post
Ordering
post
Users
The User object
Structure
Example
Create a user
post
Update a user
put
Qualification of user
put
Retrieve a user
get
List all users
get
Delete a user
delete
Search users
Relations
post
Select Fields
post
Filtering
post
Ordering
post
Rewards
The Rewards object
Structure
Example
List all rewards
get
List all remaining coupons
get
Search rewards
Relations
post
Select Fields
post
Filtering
post
Ordering
post
Rewards Due
The Rewards Due object
Structure
Example
List all due rewards
get
Issuing due reward
post
Cancel due reward
post
Update total spend of due reward
put
Search due rewards
Relations
post
Select Fields
post
Filtering
post
Ordering
post
Rewards Issued
The Rewards Issued object
Structure
Example
List all issud rewards
get
Search issued rewards
Relations
post
Select Fields
post
Filtering
post
Ordering
post
Webhooks
Errors
Powered byΒ
Structure
Below is a list of all the fields related to the rewards you setup in your dashboard.