Skip to main content

High Level

High Level (GoHighLevel) is a CRM and business automation platform for agencies and marketers. Its API provides programmatic access to contacts, opportunities, pipelines, payments, invoices, appointments, conversations, and other customer relationship data. Nexla connects to the High Level API to ingest these objects into your data flows and to write records back for contact, opportunity, invoice, and messaging automation.

High Level icon

Power end-to-end data operations for your High Level API with Nexla. Our bi-directional High Level connector is purpose-built for High Level, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to High Level or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your High Level workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a High Level credential, you need a Private Integration Token from your High Level account. High Level authenticates API requests with this token sent in the Authorization header using the Bearer scheme, and each request also includes a Version header (2021-07-28).

To obtain a Private Integration Token, follow these steps:

  1. Sign in to your High Level account.

  2. Open the Settings for the account you want to integrate. Private Integrations can be created at the agency level or within an individual sub-account, depending on the data you need to access.

  3. Navigate to the Private Integrations section under Settings.

  4. Click Create new Integration, then give the integration a descriptive name and description so your team can identify its purpose.

  5. Select the scopes (permissions) the integration needs — for example, read/write access to contacts, opportunities, invoices, payments, calendars, and conversations, matching the endpoints you plan to use in Nexla.

  6. Create the integration, then copy the generated token immediately. High Level displays the token only once and it cannot be retrieved again after you leave the page. Store it securely.

Private Integration Tokens do not expire unless you manually revoke them. High Level recommends rotating tokens periodically; when you rotate a token, the previous token continues to work for a short overlap window before it is revoked. The default API base URL is https://services.leadconnectorhq.com. For details on Private Integrations, scopes, and available endpoints, see the High Level API Documentation.

Authenticate

Credentials required

Authenticate using a High Level API key. Include the API key in the Authorization header with Bearer prefix.

FieldRequiredSecretDescription
API KeyYesYesYour High Level API key for authentication.
Base URLYesNoThe base URL for the High Level API.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your High Level Private Integration Token in the API Key field. This token is sent in the Authorization header with a Bearer prefix on every request and must be kept confidential.

  4. Enter the Base URL for the High Level API. Unless directed otherwise, use the default value https://services.leadconnectorhq.com.

    If your Private Integration Token is compromised, revoke it in your High Level settings and generate a new one. The token grants access to your High Level data according to the scopes you selected and should be treated as sensitive information.

    For detailed information about authentication, scopes, and available endpoints, see the High Level API Documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the High Level connector tile, then select the credential that will be used to connect to the High Level account, and click Next; or, create a new High Level credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common High Level endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Contacts

Returns a list of all contacts in the High Level account. Use this template to ingest contact records for analysis, segmentation, or synchronization with other systems.

[Rest API] Search Contacts

Searches for contacts based on specified criteria. Use this template to ingest a filtered subset of contacts rather than the full list.

[Rest API] List Opportunities

Returns a list of all opportunities in the High Level account. Use this template to ingest deal records across your pipelines.

[Rest API] List Pipelines

Returns a list of all sales pipelines configured in the High Level account.

[Rest API] List Payments

Returns a list of all payments recorded in the High Level account.

[Rest API] List Transactions

Returns a list of all transactions in the High Level account.

[Rest API] List Invoices

Returns a list of all invoices in the High Level account.

[Rest API] List Subscriptions

Returns a list of all subscriptions in the High Level account.

[Rest API] List Orders

Returns a list of all orders in the High Level account.

[Rest API] Get Order

Retrieves order information by order ID. Provide the Order ID of the order to retrieve when configuring this template.

[Rest API] List Form Submissions

Returns a list of all form submissions collected in the High Level account.

[Rest API] List Custom Fields

Returns a list of all custom fields defined in the High Level account.

[Rest API] List conversations (SMS, email, calls) for contacts

Lists conversations — including SMS, email, and calls — associated with contacts in the High Level account.

[Rest API] List calendar appointments / bookings

Lists calendar appointments and bookings in the High Level account.

[Rest API] List sub-account locations in the agency account

Lists the sub-account locations available within the agency account.

[Rest API] List tasks assigned to contacts or users

Lists tasks assigned to contacts or users for a given location. Provide the Location ID of the location whose tasks you want to retrieve when configuring this template.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

High Level data sources can also be manually configured to ingest data from any valid High Level API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new High Level data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the High Level destination, and select the Send to Destination option from the menu. Select the High Level connector from the list of available destination connectors, then select the credential that will be used to connect to the High Level account, and click Next; or, create a new High Level credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common High Level endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create a new contact in HighLevel CRM

Creates a new contact in HighLevel CRM using records from a Nexset. Each record is sent as a JSON request body to create a contact.

[Rest API] Update an existing contact record

Updates an existing contact record. Provide the Contact ID of the contact to update when configuring this template.

[Rest API] Create a new opportunity / deal in a pipeline

Creates a new opportunity or deal in a pipeline using records from a Nexset.

[Rest API] Update opportunity status, stage, or value

Updates the status, stage, or value of an opportunity. Provide the Opportunity ID of the opportunity to update when configuring this template.

[Rest API] Book a calendar appointment

Books a calendar appointment using records from a Nexset.

[Rest API] Create a task for a contact

Creates a task for a contact. Provide the Contact ID of the contact to create the task for when configuring this template.

[Rest API] Send an SMS, email, or other message via HighLevel

Sends an SMS, email, or other message through HighLevel using records from a Nexset.

[Rest API] Create Invoice

Creates an invoice for a contact using records from a Nexset.

[Rest API] Submit Billing Webhook

Submits a billing webhook event with payment and subscription details to the High Level billing system.

Manual configuration

High Level destinations can also be manually configured to send data to any valid High Level API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

High Level APIs typically expect JSON format for most operations. For update operations, include the ID of the object to be updated in the request URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured High Level endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the High Level endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.