ghl-sdk v1.1.6

GoHighLevel SDK for JavaScript

Installation

npm install ghl-sdk  

yarn add ghl-sdk  

pnpm add ghl-sdk  

Overview

The library is organized into distinct client modules — each responsible for a specific set of API interactions aligned with the structure described in official GHL API documentation. For example, the OAuthClient handles authentication and token management, while the LocationsClient encapsulates the location-specific endpoints. Both type definitions and retry logic are included. The pagination should be considered separately for each particular method and use case as there is no consistency across different modules of the underlying GHL API.

Quick Start

import { OAuthClient, LocationsClient, FormsClient } from 'ghl-sdk';  

// Replace this with your own valid GHL credentials
const client_id = '64720d51b50eb849194247ce-lzdnsr6z';
const client_secret = '5060d220-a031-4f39-9cr0-0424e08ffba5';
const grant_type = 'authorization_code';
const user_type = 'Location';
const code = '86b68a0da12ba59f9a85abf2f5bafde171321bdd';
const locationId = 've9EPM428h8vShlRW1KT';

// Exchange OAuth code for access token
const oauthClient = new OAuthClient();
const { access_token } = await oauthClient.getAccessToken({
  client_id,
  client_secret,
  grant_type,
  user_type,
  code,
});

// Fetch location details
const locationsClient = new LocationsClient(accessToken);
const { location } = await locationsClient.findById(locationId);  
console.log(location.name);  

// Fetch the available forms for location
const formsClient = new FormsClient(accessToken);
const { forms, total } = await formsClient.find({ locationId, limit: 100 });
console.log(`Fetched ${forms.length} forms out of ${total}`);

Client Modules

Here's the list of all available client modules and their methods in relation to the official GoHighLevel API documentation. All the type definition details can be found on the auto-generated typedoc pages.

BlogsClient

BusinessesClient

CalendarsClient

CampaignsClient

CompaniesClient

ContactsClient

ConversationsClient

CoursesClient

CustomFieldsClient

CustomMenusClient

EmailsClient

FormsClient

FunnelsClient

InvoicesClient

LCEmailClient

LinksClient

LocationsClient

MediaClient

OAuthClient

ObjectsClient

OpportunitiesClient

PaymentsClient

ProductsClient

SaasClient

SnapshotsClient

SurveysClient

UsersClient

WorkflowsClient