API Reference

This reference documents the GrowSurf 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.
​​
​​
Campaigns
get
https://api.growsurf.com/v2
/campaign/:id
Get Campaign
get
https://api.growsurf.com/v2
/campaigns
Get Campaigns
Participants
get
https://api.growsurf.com/v2
/campaign/:id/participant/:participantId
Get Participant by ID
get
https://api.growsurf.com/v2
/campaign/:id/participant/:participantEmail
Get Participant by Email
get
https://api.growsurf.com/v2
/campaign/:id/participants
Get Participants
get
https://api.growsurf.com/v2
/campaign/:id/leaderboard
Get Leaderboard
post
https://api.growsurf.com/v2
/campaign/:id/participant
Add Participant
Metadata: Please see our API Guidelines for more information about metadata.
† What's a campaign referral trigger?
You can update the campaign referral trigger in the Installation step of the Campaign Editor (see image). Depending on what you select, the API will automatically set a default value for the participant:
If the referral trigger is Sign up + Qualifying Action, then referralStatus will default to CREDIT_PENDING
If the referral trigger is Sign Up, then referralStatus will default to CREDIT_AWARDED
post
https://api.growsurf.com/v2
/campaign/:id/participant/:participantId/ref
Trigger Referral by Participant ID
Important Notes:
Referral credit will only be awarded to the referrer if the participant referralStatus has a value of CREDIT_PENDING
Make sure your campaign's referral trigger is set to Sign Up + Qualifying Action (see image). If the referral trigger is set to Sign Up Event, triggering referrals will not work since referral credit has already been provided.
post
https://api.growsurf.com/v2
/campaign/:id/participant/:participantEmail/ref
Trigger Referral by Participant Email
Important Notes:
Referral credit will only be awarded to the referrer if the participant referralStatus has a value of CREDIT_PENDING
Make sure your campaign's referral trigger is set to Sign Up + Qualifying Action (see image). If the referral trigger is set to Sign Up, triggering referrals will not work since referral credit has already been provided.
post
https://api.growsurf.com/v2
/campaign/:id/participant/:participantId
Update Participant by ID
*Please see our API Guidelines for more information about metadata.
post
https://api.growsurf.com/v2
/campaign/:id/participant/:participantEmail
Update Participant by Email
*Please see our API Guidelines for more information about metadata.
delete
https://api.growsurf.com/v2
/campaign/:id/participant/:participantId
Remove Participant by ID
delete
https://api.growsurf.com/v2
/campaign/:id/participant/:participantEmail
Remove Participant by Email
Participant Rewards
get
https://api.growsurf.com/v2
/campaign/:id/participant/:participantId/rewards
Get Participant Rewards by Participant ID
get
https://api.growsurf.com/v2
/campaign/:id/participant/:participantEmail/rewards
Get Participant Rewards by Participant Email
post
https://api.growsurf.com/v2
/campaign/:id/reward/:rewardId/approve
Approve Participant Reward
post
https://api.growsurf.com/v2
/campaign/:id/reward/:rewardId/fulfill
Fulfill Participant Reward
delete
https://api.growsurf.com/v2
/campaign/:id/reward/:rewardId
Remove Participant Reward
Referrals and Invites
get
https://api.growsurf.com/v2
/campaign/:id/referrals
Get Referrals and Invites
get
https://api.growsurf.com/v2
/campaign/:id/participant/:participantId/referrals
Get Participant Referrals and Invites by ID
get
https://api.growsurf.com/v2
/campaign/:id/participant/:participantEmail/referrals
Get Participant Referrals and Invites by Email
post
https://api.growsurf.com/v2
/campaign/:id/participant/:participantId/invites
Send Participant Invites by ID
post
https://api.growsurf.com/v2
/campaign/:id/participant/:participantEmail/invites
Send Participant Invites by Email
Objects
Next - Automate Rewards
Tango Card
Last modified 19d ago