ReferralHero API Documentation

This is the complete API documentation for connecting to the ReferralHero API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet ReferralHero: Manage referral campaigns, subscribers, rewards, and coupons. Keep reading to get started.

Quickstart

Before you run your first ReferralHero request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one ReferralHero connection — create or choose one in Connections. Note its connectionId.

Every ReferralHero action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/referralHero/actions/{actionSlug}/run

You need a MindCloud API Key and a ReferralHero connection. Then call an action such as List Lists:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/referralHero/actions/list-lists/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your ReferralHero account. See ReferralHero API Authentication for the full flow and how to get your connection credentials.

ReferralHero actions

All 24 published actions for this ReferralHero version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Subscriber
• POSTCreate Coupon Group
• POSTCreate Coupons
• POSTCreate List
• DELETEDelete Subscriber
• GETGet List Leaderboard
• GETList All Level 2 Referrals
• GETList Coupon Groups
• GETList Coupons
• GETList Level 1 Referrals
• GETList Level 2 Referrals
• GETList Level 3 Referrals
• GETList List Rewards
• GETList Lists
• GETList Referred Subscribers
• GETList Rewards for All Subscribers
• GETList Subscriber Rewards
• GETList Subscribers
• GETRetrieve Subscriber by Email
• GETRetrieve Subscriber by ID
• GETRetrieve Subscriber by MWR
• POSTTrack Bulk Transactions
• POSTTrack Single Transaction
• PUTUpdate Subscriber

Related apps

More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.

Google FormsMailchimpCalendlyWebflowGoogle AdsActiveCampaignBrevoMailerLite