Getting and Using ClearPoint API Keys

This article explains how to generate and manage API Keys for integrating external applications with your ClearPoint account.

Fernando Montenegro
15 steps
30 seconds

Clearpointstrategy

API keys authorize applications to securely access ClearPoint data and functionality without requiring a user’s password.

What Are APIs and API Keys?

An **API (Application Programming Interface)** allows different applications to communicate with each other. It sends requests, retrieves the needed information, and returns responses. To learn more, see our full **ClearPoint API support article**. **API Keys** authorize an external application to access ClearPoint “on behalf of” a specific user—without exposing that user’s password. 🔎 **Note:**\ API Keys and Data Loader Keys are now separate.\ For Data Loader Keys, see [**Data Loader 2.0**](https://next-support.clearpointstrategy.com/en/articles/12683430-automation-integration-data-loader).

Creating an API Key

To generate a new API Key: 1. From the top navigation, click **Settings**. 2. Choose **Integrations**.

1. Navigate to the **API Keys** tab. 2. Click the **Add API Key** (+) icon.

## Configure the API Key 1. Enter an **API Key Name** — for example, *Integration*. - We recommend using the name of the application that will use the key. 2. Under **Expires**, set an expiration date. 3. Use the **Mapped User Account** dropdown menu to select a user account. - Only elements visible to this mapped user will be accessible through the key. 4. Click **Save**.

Your new key will appear in the API Keys list.

Managing API Keys

From the API Keys list, you can **edit, view, or delete** existing keys.

## Edit an API Key 1. Click the **kebab menu (⋮)** and select **Edit API Key**.

1. From the **Edit API Key** drawer, you can: - Key name - Expiration date - Mapped user 2. Click **Save**.

## Delete an API Key If a key is no longer needed or you suspect it is compromised: 1. Click the **kebab menu (⋮)** and select **Delete API Key**.

1. Confirm by clicking the red **Delete** button. 💡 Deleting a key immediately disables access through that key.

Using Your API Keys

ClearPoint API Keys consist of two parts: - **API Key** - **Secret Key** To use the API Key, include both as request headers in your HTTP calls: 🚨 **Important:**\ Treat these keys like passwords—they grant access to your account and should never be shared.

API Key Security Best Practices ⚠️

- Treat API Keys as sensitive credentials. - Delete keys immediately when they are no longer needed. - Regenerate keys if you suspect misuse. - Assign the mapped user with the **minimum required permissions**. - Use expiration dates to reduce long-term exposure risk.

To delete a compromised key: 1. Go to **Settings**. 2. Choose **Integrations**.

1. Navigate to the **API Keys** tab. 2. Click the **kebab menu (⋮)** and select **Delete API Key**. 3. Confirm deletion.