# How to connect to Freshsales

Freshsales (Freshworks CRM) gives every user a unique API key. To connect, you need two values from your Freshsales account: your **API key** and your **bundle alias**. Freshworks describes both in the [Freshworks CRM API documentation](https://developers.freshworks.com/crm/api/).

## Prerequisites

- A Freshsales user account. The connection acts with the permissions of the user whose API key you use, so use a user whose role can view and edit every record you want to sync.

---

## 1. Open your API Settings

- Log in to Freshsales
- Click your **profile picture** and select **Profile Settings**
- Click the **API Settings** tab

![personal-settings](https://res.cloudinary.com/apideck/image/upload/v1754649635/docs/connectors/freshworks-crm/personal-settings.png)

---

## 2. Copy your API key and bundle alias

- On the **API Settings** tab, copy the value in **Your API key**
- Your **bundle alias** is shown below the API key on the same tab. Copy it as well

![copy-api-key](https://res.cloudinary.com/apideck/image/upload/v1754649635/docs/connectors/freshworks-crm/copy-api-key.png)

The bundle alias is the first part of your Freshsales web address. For example, if your account lives at `mycompany.myfreshworks.com/crm/sales`, your bundle alias is:

`mycompany`

---

## 3. Add the credentials in Vault

- In the **Subdomain** field, enter your bundle alias (Vault calls it **Subdomain**; Freshworks labels the same value **Bundle alias**)
- In the **API Key** field, paste your API key
- Click **Save** to authorise the connection

![configure-vault](https://res.cloudinary.com/apideck/image/upload/v1754649636/docs/connectors/freshworks-crm/configure-vault.png)

---

## Notes

- There are no scopes to choose. Access follows the role of the user who owns the API key.
- The screenshots above may show an older version of the Freshsales menu. Follow the menu names in the steps: **Profile Settings**, then the **API Settings** tab.
- Clicking **Reset Key** on the API Settings tab revokes the old key for every integration that uses it. If you reset your key, enter the new key in Vault to keep the connection working.

## Troubleshooting

- **Requests fail after the connection was working:** check whether the API key was reset and whether your Freshsales subscription is still active. Then re-enter a current API key in Vault.
- **Connection fails right after saving:** enter only the bundle alias in the **Subdomain** field (for example `mycompany`), not the full web address.