> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/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.

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *HighLevel*.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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 [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl -X POST "https://api.nango.dev/proxy/contacts/search" \
          -H "Authorization: Bearer <NANGO-SECRET-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>

      <Tab title="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({ secretKey: '<NANGO-SECRET-KEY>' });

        const res = await nango.post({
            endpoint: '/contacts/search',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>',
            headers: {
              Version: '2021-07-28'
            }
        });

        console.log(res.data);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials dynamically via the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

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

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 HighLevel Integration Guides

Nango-maintained guides for common use cases.

* [How to register your own HighLevel OAuth app](/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 & actions for HighLevel

Enable them in your dashboard. Extend and customize to fit your needs.

### Others

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

***
