> For the complete documentation index, see [llms.txt](https://referral-rocket.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://referral-rocket.gitbook.io/docs/developer-tools/rest-api.md).

# REST API

To utilize our REST API, you'll need to employ an API key, which can be located within the "API Key" section of your settings page. 

<figure><img src="https://346708387-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpvWNOwMd3hfowlhBXaA%2Fuploads%2FlMOdszTfVlU0wBWUVl5z%2FScreenshot%202023-10-30%20at%208.35.25%20PM.png?alt=media&amp;token=05d8ace9-d5a5-45d4-9c54-d8c3a9caf632" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}

* Access to our REST API is exclusively accessible through the Pro pricing plan.
* Safeguard the confidentiality of your API key at all costs; refrain from sharing it or making it publicly accessible. Your API key is a vital component of your account/data security
  {% endhint %}

**Example**

Our API endpoint is available at `https://app.referralrocket.io/api/v1/`. You can make an API request by passing the x-api-key in the header. Remember to use your API key.

{% code fullWidth="false" %}

```
curl -X "GET" 'https://app.referralrocket.io/api/v1/getCampaign?id=<campaignId>' \
--header 'x-api-key: ebgc_zDsr7kiuGi_ahO_MmlZ-jB-S451mMO3dvV2DK0='
```

{% endcode %}