API Reference

This reference documents the LoyaltySurf REST API, including all available public methods and examples of each.
Open in Postman
Easily test these API methods dynamically by using our Postman Collection.  Just change the Token in the Authorizations tab, and the campaign_id variable to the campaign you're working on.
​​
​​
Campaigns
get
https://api.loyaltysurf.io/v1
/campaign/:id
Get Campaign
get
https://api.loyaltysurf.io/v1
/campaigns
Get Campaigns
Loyalty Actions
post
https://api.loyaltysurf.io/v1 
/campaign/:id/loyalty-action
Trigger Loyalty Action by Email
Metadata: Please see our API Guidelines​ for more information about metadata.
post
https://api.loyaltysurf.io/v1
/campaign/:id/loyalty-action
Trigger Loyalty Action by Participant ID
Participants
get
https://api.loyaltysurf.io/v1
/campaign/:id/participant/:participantId
Get Participant by ID
get
https://api.loyaltysurf.com/v1
/campaign/:id/participant/:participantEmail
Get Participant by Email
get
https://api.loyaltysurf.io/v1
/campaign/:id/participants
Get Participants
get
https://api.loyaltysurf.io/v1
/campaign/:id/leaderboard
Get Leaderboard
post
https://api.loyaltysurf.io/v1
/campaign/:id/participant
Add Participant
Metadata: Please see our API Guidelines for more information about metadata.
post
https://api.loyaltysurf.io/v1
/campaign/:id/participant/:participantId
Update Participant by ID
*Please see our API Guidelines for more information about metadata.
post
https://api.loyaltysurf.io/v1
/campaign/:id/participant/:participantEmail
Update Participant by Email
*Please see our API Guidelines for more information about metadata.
delete
https://api.loyaltysurf.io/v1
/campaign/:id/participant/:participantId
Remove Participant by ID
delete
https://api.loyaltysurf.io/v1
/campaign/:id/participant/:participantEmail
Remove Participant by Email
Participant Rewards
get
https://api.loyaltysurf.io/v1
/campaign/:id/participant/:participantId/rewards
Get Participant Rewards by Participant ID
get
https://api.loyaltysurf.io/v1
/campaign/:id/participant/:participantEmail/rewards
Get Participant Rewards by Participant Email
post
https://api.loyaltysurf.io/v2
/campaign/:id/reward/:rewardId/approve
Approve Participant Reward
post
https://api.loyatysurf.io/v1
/campaign/:id/reward/:rewardId/fulfill
Fulfill Participant Reward
delete
https://api.loyaltysurf.io/v1
/campaign/:id/reward/:rewardId
Remove Participant Reward
Objects
API Guidelines
Last modified 4d ago