Endpoint Reference

Lists

Locations where you can find most of the required parameters:
Path Parameters
Location
api_token
ReferralHero dashboard > Account > API
name
ReferralHero dashboard > Campaign name
uuid
ReferralHero dashboard > Campaign > Installation > Instructions
The 12-letter id that starts with ‘MF’ in the Tracking Code, e.g. MF078d000987
get
https://app.referralhero.com/api/v2
/lists
Retrieve all lists
post
https://app.referralhero.com/api/v2
/lists
Create a new list
get
https://app.referralhero.com/api/v2
/lists/:uuid/leaderboard
Get List Leaderboard
get
https://app.referralhero.com/api/v2
/lists/:uuid/bonuses
Get list rewards

Subscribers

Locations where you can find most of the required parameters:
Path Parameters
Location
api_token
ReferralHero dashboard > Account > API
uuid
ReferralHero dashboard > Campaign > Installation > Instructions
The 12-letter id that starts with ‘MF’ in the Tracking Code, e.g. MF078d000987
email
The email of the subscriber
domain
ReferralHero dashboard > Campaign > Options > Default Referral Link
subscriber_id
ReferralHero dashboard > Campaign > Subscribers
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers
Retrieve all subscribers from a list
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers
Create a new subscribers
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id
Retrieve subscriber by ID
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/retrieve_by_email
Retrieve subscriber by email
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id
Update a subscriber
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id/confirm
Confirm referral
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id/promote
Promote a subscriber
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id/referred
Retrieve all referrals of a subscriber
delete
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id
Delete a subscriber
Last modified 3mo ago