Getting Started


The ReferralHero API is organized around REST. Our API has predictable, resource-oriented URLs. JSON is returned by all API responses, including errors.

Base URL

Calls for ReferralHero API are relative to the URL

For Staging:

For Production:

Request Headers

  1. Authorization - Your access token

  2. Accept - application/vnd.referralhero.v1

  3. Content-Type - application/json

To summarize, your request headers should look like this


   'Content-Type': 'application/json',
   'Accept': 'application/vnd.referralhero.v1',
   'Authorization': 'xxxxxxxxxx'


Data Definition

To see a list of all the available List, Subscriber, and Reward Objects see here.

Last updated