This section gives a detailed guide on all Referd APIs that are needed during integration.

The Referd API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. In this section, you will find all the available APIs required across all Referd features as well as all the API methods that can be used in the SDKs.


Before using any of our API endpoints, you need to get familiar with how Referd authenticates any incoming requests. Which is described in details in the Authentication section.

API Reference

Referd provides a set of endpoints which enables you to interact with and utilize Referd Engine efficiently. All supported endpoints are described as follows:

Base URL

The API base URL is the following, with v3.0 as our current version.


Check the following section to learn more about the API Reference.

API Endpoint Testing

To facilitate efficient testing and exploration of our API endpoints, we provide a dedicated Postman collection. This collection encompasses a comprehensive set of API calls, streamlining your testing process. To make the most of this Postman collection, detailed instructions on how to use each API endpoint and harness its capabilities have been meticulously documented in API Endpoint Testing Section.


Learn more about common errors and their description in our Errors section.

Last updated