Introduction API V2
So you are building an integration with ReferralHero. GREAT! We're very excited that you want to add-on to our platform. Before you dive in and start coding, make sure you read this page to know how to structure your app.
The ReferralHero API is organized around REST. Our API has predictable, resource-oriented URLs.
JSON is returned by all API responses, including errors.
ReferralHero API V2 is in active development, hence expect things to change. We will add new endpoints and change minor details here and there, but if and when we will introduce breaking changes we will notify you at least 2 weeks in advance.
Calls for ReferralHero API v2 are relative to the URL https://app.referralhero.com/api/v2
All API calls require the
api_token parameter. You can find your API Token in your API P age.
Currently, we apply a "soft" limit of 5,000 API calls per hour. Get in touch with us if you need to increase it.
If your request rate exceeds our limits, you will receive an HTTP status of 429 with an error code "too_many_calls".
We have created step-by-step tutorials for some common use cases. You can find them he re.
We hope you enjoy using our API and please report any bugs or unexpected behaviour :)