Referral Factory API Documentation

This is the complete API documentation for connecting to the Referral Factory 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 Factory: Manage referral campaigns, users, and rewards. Keep reading to get started.

Quickstart

Before you run your first Referral Factory 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 Referral Factory connection — create or choose one in Connections. Note its connectionId.

Every Referral Factory action uses the same URL pattern:

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

You need a MindCloud API Key and a Referral Factory connection. Then call an action such as List Campaigns:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/referralFactory/actions/list-campaigns/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 Referral Factory account. See Referral Factory API Authentication for the full flow and how to get your connection credentials.

Referral Factory actions

All 11 published actions for this Referral Factory version. Each page documents the endpoint, arguments, and response controls.

• GETList Campaigns
• GETList Due Rewards
• GETList Issued Rewards
• GETList Rewards
• GETList Users
• GETRetrieve Campaign
• GETSearch Campaigns
• GETSearch Due Rewards
• GETSearch Issued Rewards
• GETSearch Rewards
• GETSearch Users

Related apps

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

Google FormsMailchimpCalendlyWebflowGoogle AdsActiveCampaignBrevoMailerLite