> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# HighLevel

> Integrate your application with the HighLevel API

## 🚀 Quickstart

Connect to HighLevel with Nango and see data flow in 2 minutes.

**1. Create the integration**

In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *HighLevel*.

**2. Authorize HighLevel**

Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to HighLevel. Later, you'll let your users do the same directly from your app.

**3. Call the HighLevel API**

Let's make your first request to the HighLevel API (fetch a list of contacts). Replace the placeholders below with your [Environment API key](https://nango.dev/docs/reference/backend/http-api/api-keys.md), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

> [tab] cURL
>
> ```bash theme={null}
> curl -X POST "https://api.nango.dev/proxy/contacts/search" \
>   -H "Authorization: Bearer <NANGO-API-KEY>" \
>   -H "Provider-Config-Key: <INTEGRATION-ID>" \
>   -H "Connection-Id: <CONNECTION-ID>" \
>   -H "nango-proxy-version: 2021-07-28" \
>   -H "Content-Type: application/json"
> ```

> [tab] Node
>
> Install Nango's backend SDK with `npm i @nangohq/node`. Then run:
>
> ```typescript theme={null}
> import { Nango } from '@nangohq/node';
>
> const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });
>
> const res = await nango.post({
>     endpoint: '/contacts/search',
>     providerConfigKey: '<INTEGRATION-ID>',
>     connectionId: '<CONNECTION-ID>',
>     headers: {
>       Version: '2021-07-28'
>     }
> });
>
> console.log(res.data);
> ```

Or fetch credentials dynamically via the [Node SDK](https://nango.dev/docs/reference/backend/backend-sdk/node.md#get-a-connection-with-credentials) or [API](https://nango.dev/docs/reference/backend/http-api/connections/get.md).

✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.

**4. Implement Nango in your app**

Follow our [Auth implementation guide](https://nango.dev/docs/guides/primitives/auth.md) to integrate Nango in your app.

To obtain your own credentials, follow the setup guide linked below.

## 📚 HighLevel Integration Guides

Nango-maintained guides for common use cases.

* [How to register your own HighLevel OAuth app](https://nango.dev/docs/api-integrations/highlevel/how-to-register-your-own-highlevel-api-oauth-app)\
  Register an OAuth app with HighLevel to obtain your client credentials

Official docs: [HighLevel API documentation](https://marketplace.gohighlevel.com/docs/)

## 🧩 Pre-built syncs & tools for HighLevel

Explore Nango-provided tools in your dashboard. Extend and customize them to fit your needs.

### Others

| Function name | Description | Type |
| - | - | - |
| `add-contact-to-workflow` | Enroll a contact in a HighLevel workflow. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `add-tags-to-contact` | Add one or more tags to a contact. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `check-duplicate-contact` | Look up an existing contact by email or phone to avoid creating duplicates. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-appointment` | Create an appointment on a calendar in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-calendar` | Create a calendar in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-contact-note` | Add a note to a contact | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-contact-task` | Create a follow-up task on a contact. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-contact` | Create a contact in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-custom-field` | Create a custom field in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-custom-value` | Create a location-level custom value (a named merge variable, distinct from a per-contact custom field). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-opportunity` | Create an opportunity in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-appointment` | Delete an appointment in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-calendar` | Delete a calendar in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-contact-task` | Delete a follow-up task from a contact. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-contact` | Delete a contact in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-conversation` | Delete a conversation in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-custom-field` | Delete a custom field in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-custom-value` | Delete a custom value in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-opportunity` | Delete an opportunity in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-appointment` | Retrieve a single appointment from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-calendar` | Retrieve a single calendar from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-contact` | Retrieve a single contact from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-conversation` | Retrieve a single conversation from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-custom-field` | Retrieve a single custom field from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-custom-value` | Retrieve a single custom value from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-location` | Retrieve details about the connected HighLevel location (sub-account). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-message` | Retrieve a single message by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-opportunity` | Retrieve a single opportunity from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-user` | Retrieve a single user from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-appointments` | List appointments from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-calendars` | List calendars from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-contact-notes` | List notes on a contact. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-contact-tasks` | List follow-up tasks on a contact | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-contacts` | List contacts from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-conversation-messages` | List messages within a conversation. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-conversations` | List conversations from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-custom-fields` | List custom fields from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-custom-values` | List location-level custom values from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-opportunities` | List opportunities from HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-pipelines` | List opportunity pipelines and their stages for a location. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-users` | List users assigned to a location in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-workflows` | List workflow definitions (id, name, status) for a location. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `remove-contact-from-workflow` | Remove a contact from a HighLevel workflow | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `remove-tags-from-contact` | Remove one or more tags from a contact. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `send-conversation-message` | Send an SMS, email, or other message through a HighLevel conversation. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-appointment` | Update an appointment in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-calendar` | Update a calendar in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-contact-task` | Update a follow-up task on a contact, e.g. mark it complete. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-contact` | Update a contact in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-conversation` | Update a conversation in HighLevel (e.g. mark read/unread). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-custom-field` | Update a custom field in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-custom-value` | Update a custom value in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-opportunity` | Update an opportunity in HighLevel. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `upsert-contact` | Create a contact in HighLevel, or update it in place if a contact with the same email/phone already exists. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `appointments` | Sync appointments (calendar events) from HighLevel | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `calendars` | Sync calendars from HighLevel. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `contacts` | Sync contacts from HighLevel | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `conversations` | Sync conversations from HighLevel | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `custom-fields` | Sync custom fields from HighLevel | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `opportunities` | Sync opportunities from HighLevel. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `users` | Sync users assigned to this location from HighLevel. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `workflows` | Sync workflow definitions (id, name, status) from HighLevel. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.