> For the complete documentation index, see [llms.txt](https://docs.sprinthub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinthub.com/en/topics/api/api-how-to-register-the-api-key.md).

# API - How to register the API key

## How to Register the API Key in Sprinthub CRM

<figure><img src="https://684109703-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FKtas5qEFhzw2tuxC7YGc%2Fundraw_real-time-analytics_xu2g.png?alt=media&amp;token=7d3eafe7-cbf9-476e-afba-88859570f612" alt=""><figcaption></figcaption></figure>

Sprinthub CRM allows you to integrate various platforms to automate processes and improve your team's performance. One of these integrations is done through the use of a **API key**, which is essential for establishing secure communication between systems. Below, we will teach you step by step how to register the API key in Sprinthub CRM.

### Step 1: Access the Settings Menu

1. Open the **Sprinthub CRM** and sign in to your account.
2. In the upper-right corner of the screen, click the **gear** to access the settings menu.

<figure><img src="https://684109703-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2Ft92r5Jdvy4MOwxo3X0qk%2Fimage.png?alt=media&amp;token=a53188bb-8edc-4e0a-a046-7e9843366de6" alt=""><figcaption></figcaption></figure>

### Step 2: Navigate to the Integrations Section

1. In the side menu, find and click the Documentation and API key option.

<figure><img src="https://684109703-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FTlDcGpdRfNUy07ouC6R2%2Fimage.png?alt=media&amp;token=0ff392ba-8a1c-4b30-a0cb-bb68c85c7529" alt=""><figcaption></figcaption></figure>

### Step 3: Generate or Add an API Key

1. Click the button **Generate New Key** if you do not already have one.
   * A unique code will be generated that will work as your access key.
2. If you already have an API key, click **Add Key** and enter the code provided by the platform you want to integrate.

<figure><img src="https://684109703-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FJNCydcZAu4TuNC36Nkp8%2Fimage.png?alt=media&amp;token=d6e23c23-859c-46b0-8611-f56c436564ed" alt=""><figcaption></figcaption></figure>

When you click it, the option to add a name, the user whose permissions will be used, and the enabled or disabled status will appear.&#x20;

<figure><img src="https://684109703-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FUV2oAE2PRVAtrnrXpgkR%2Fimage.png?alt=media&amp;token=e2dd2ac6-3ba5-4642-b009-ce06a1331eba" alt=""><figcaption></figcaption></figure>

> **Attention:** Make sure to copy the key exactly as it is displayed, because any error will prevent the integration.

### Step 4: Configure Permissions

1. After registering the key, you will be able to configure the permissions for the integration.
2. Choose the resources that the integrated platform can access, such as:
   * Contacts
   * Leads
   * Deals

Click on **Save** to confirm the settings.

<figure><img src="https://684109703-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FkpDwp9DwVo7O3yy3SF1g%2Fimage.png?alt=media&amp;token=ee31f4f4-4e01-4c5c-a52f-08b97fbc9c8b" alt=""><figcaption></figcaption></figure>

### Step 5: Test the Integration

1. After setting up the API key, it is important to test the connection.
2. Check whether the data is being sent and received correctly between the platforms.

Done! Your API key is now registered and working in Sprinthub CRM. If you have questions or encounter problems during the process, contact Sprinthub technical support.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.sprinthub.com/en/topics/api/api-how-to-register-the-api-key.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.