# 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="/files/epij7k4lfBz9mlsZWGQD" 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 %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://referral-rocket.gitbook.io/docs/developer-tools/rest-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.