Referral Rock API Documentation
This is the complete API documentation for connecting to the Referral Rock 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 Referral Rock: Manage referral programs, members, referrals, rewards, and payouts. Keep reading to get started.
Quickstart
Before you run your first Referral Rock request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Referral Rock connection — create or choose one in Connections. Note its
connectionId.
Every Referral Rock action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/referralRock/latest/actions/{actionSlug}You need a MindCloud API Key and a Referral Rock connection. Then call an action such as Get Member Statistics:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/referralRock/latest/actions/get-member-statistics" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"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.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Referral Rock account that should run the action. MindCloud stores and refreshes the Referral Rock credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Referral Rock actions
All 25 published actions for this Referral Rock version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Hook
- POSTCreate Member
- POSTCreate Member Access URLs
- POSTCreate Payout Transactions
- POSTCreate Referral
- POSTCreate Rewards
- DELETEDelete Hook
- DELETEDelete Members
- DELETEDelete Referrals
- DELETEDelete Rewards
- GETGet Member Statistics
- GETGet Program
- GETGet Referral
- PUTIssue Reward
- GETList Members
- GETList Payout Transactions
- GETList Payouts
- GETList Pending Payouts
- GETList Programs
- GETList Referrals
- GETList Reward Rules
- GETList Rewards
- PUTUpdate Members
- PUTUpdate Referrals
- PUTUpdate Rewards
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.