GHL Developer Docs Reference

Complete API, Webhook, Auth & MCP reference scraped from marketplace.gohighlevel.com

63 Webhook Events 40+ API Endpoints OAuth 2.0 + PIT Auth MCP Server AI Agent Studio
63
Webhook Events
40+
API Endpoints
10
API Categories
4
KB Articles Written
30+
Doc Sections

Quick Reference

Base API URLhttps://services.leadconnectorhq.com
Auth HeaderAuthorization: Bearer <TOKEN>
Token ExpiryAccess: ~24h (86,399s) | Refresh: 1 year (single-use)
OAuth Token URLPOST /oauth/token
Location TokenPOST /oauth/locationToken
Agent Studio API/agent-studio/public-api/agents
Rate Limit300 req/min per sub-account (Agent Studio)
Docs Homemarketplace.gohighlevel.com/docs/

Contacts

Manage contacts, leads, customer data. CRUD, tagging, custom fields.

GET/contacts/:idcontacts.readonly
POST/contacts/contacts.write
PUT/contacts/:idcontacts.write
POST/contacts/upsertcontacts.write
DEL/contacts/:idcontacts.write
GET/contacts/business/:idcontacts.readonly

Conversations

SMS, email, call communications. Threads, messages, assignments.

GET/conversations/:idconversations.readonly
POST/conversations/conversations.write
PUT/conversations/:idconversations.write
DEL/conversations/:idconversations.write

Calendars

Appointments, booking workflows, free slots, calendar types.

GET/calendars/:id/free-slotscalendars.readonly
POST/calendars/calendars.write
GET/calendars/:idcalendars.readonly
GET/calendars/calendars.readonly
PUT/calendars/:idcalendars.write
DEL/calendars/:idcalendars.write

Opportunities

Sales pipeline, deals, stage tracking, monetary values.

GET/opportunities/:idopportunities.readonly
POST/opportunities/opportunities.write
PUT/opportunities/:idopportunities.write
DEL/opportunities/:idopportunities.write
PUT/opportunities/:id/statusopportunities.write
POST/opportunities/upsertopportunities.write

Workflows

List workflows by location. Draft/published status tracking.

GET/workflows/workflows.readonly

Campaigns

List campaigns with status filtering.

GET/campaigns/campaigns.readonly

Forms

Form listing, submissions with attribution data, file uploads.

GET/forms/forms.readonly
GET/forms/submissionsforms.readonly
POST/forms/upload-custom-filesforms.write

Payments

White-label integration providers (Authorize.net, NMI).

POST/payments/integrations/provider/whitelabelpayments.write
GET/payments/integrations/provider/whitelabelpayments.readonly

Agent Studio API

Execute AI agents programmatically. 300 req/min. Production only.

GET/agent-studio/public-api/agentsList agents
GET/agent-studio/public-api/agents/:idGet agent
POST/agent-studio/public-api/agents/:id/executeExecute

OAuth & Auth

Token exchange, refresh, location token generation.

POST/oauth/tokenGet/refresh token
POST/oauth/locationTokenAgency→Location

App Events (4)

AppInstall
AppUninstall
AppUpdate
PlanChange

Contact Events (5)

ContactCreate
ContactDelete
ContactUpdate
ContactDndUpdate
ContactTagUpdate

Message Events (4)

InboundMessage
OutboundMessage
ProviderOutboundMessage
LCEmailStats

Opportunity Events (7)

OpportunityCreate
OpportunityDelete
OpportunityUpdate
OpportunityAssignedToUpdate
OpportunityMonetaryValueUpdate
OpportunityStageUpdate
OpportunityStatusUpdate

Appointment Events (3)

AppointmentCreate
AppointmentDelete
AppointmentUpdate

Invoice Events (7)

InvoiceCreate
InvoiceDelete
InvoicePaid
InvoicePartiallyPaid
InvoiceSent
InvoiceUpdate
InvoiceVoid

Task Events (3)

TaskCreate
TaskComplete
TaskDelete

User Events (3)

UserCreate
UserDelete
UserUpdate

Location Events (2)

LocationCreate
LocationUpdate

Note Events (3)

NoteCreate
NoteDelete
NoteUpdate

Product Events (3)

ProductCreate
ProductDelete
ProductUpdate

Price Events (3)

PriceCreate
PriceDelete
PriceUpdate

Order Events (2)

OrderCreate
OrderStatusUpdate

Conversation (1)

ConversationUnreadWebhook

Campaign (1)

CampaignStatusUpdate

Association Events (3)

AssociationCreate
AssociationDelete
AssociationUpdate

Record Events (3)

RecordCreate
RecordDelete
RecordUpdate

Relation Events (2)

RelationCreate
RelationDelete

Object Schema (2)

ObjectSchemaCreate
ObjectSchemaUpdate

Voice AI (1)

VoiceAiCallEnd

External Auth (1)

ExternalAuthConnected

SaaS (1)

SaaSPlanCreate

OAuth 2.0 Flow

Authorization Code Grant — for marketplace apps and multi-account integrations.

1. Register App at marketplace.gohighlevel.com 2. Configure: scopes, redirect URL, client keys 3. User installs app -> redirected to your URL with ?code=AUTH_CODE 4. Exchange code for tokens: POST https://services.leadconnectorhq.com/oauth/token { "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET", "grant_type": "authorization_code", "code": "AUTH_CODE", "user_type": "Company", "redirect_uri": "https://your-app.com/callback" } Response: { access_token, refresh_token, expires_in: 86399, userType, companyId } 5. Refresh tokens before expiry (24h): POST /oauth/token grant_type=refresh_token 6. Generate location token from agency token: POST /oauth/locationToken { companyId, locationId }

Private Integration Token (PIT)

Static tokens for internal/simple integrations. No auto-refresh needed.

Usage: curl -H "Authorization: Bearer YOUR_PIT" \ -H "Version: 2021-07-28" \ https://services.leadconnectorhq.com/contacts/ Best Practices: - Rotate every 90 days - 7-day grace period during rotation (both tokens work) - Emergency rotation: immediate invalidation - Minimum scopes principle

When to Use PIT

Internal API access, single sub-account, no webhooks/custom pages, simple setup. Generated from UI, static/fixed.

When to Use OAuth

Public integrations, multi-account, webhooks & custom modules, advanced security. Programmatic token management.

MCP Server

Model Context Protocol — connect external tools to GHL AI agents.

What it does: GHL's MCP Server feature lets you create custom MCP tools that GHL's native AI agents (Agent Studio) can call. MCP servers expose:

  • Tools — Actions the AI agent can execute
  • Resources — Data the agent can read
  • Prompts — Pre-configured prompt templates

Status: Listed in developer docs navigation. Documentation pages are being built (not yet publicly accessible at scraped URLs).

Our integration: We can create custom MCP servers exposing SkillBoss endpoints, n8n workflows, and our agent capabilities to GHL's built-in AI.

AI Agent Studio

Visual AI agent builder with Tool Nodes (Web Search, MCP, API, KB), Generative Nodes (LLM, image gen), and Capture Nodes.

GET/agent-studio/public-api/agents
GET/agent-studio/public-api/agents/:id
POST/agent-studio/public-api/agents/:id/execute

300 req/min | Production only | 30-min session timeout

Invoke Agent (Workflow Action)

Execute Production Agent Studio agents mid-workflow. Pass merge fields, map variables, capture JSON response. 60-second timeout.

Ask AI Integration

Routes user prompts to best-matching Agent Studio agent based on capability descriptions. Dashboard-side interface. Requires Unlimited AI Employee plan.

Knowledge Base (GHL Native)

Built-in KB for AI agents. Stores documents/FAQs. Queried by Conversation AI and Agent Studio agents for domain-specific context.

Conversation AI

AI-powered automated conversations across all channels (SMS, Email, FB, IG, WhatsApp, Live Chat). Integrates with Agent Studio.

Voice AI

AI-powered voice calling. VoiceAiCallEnd webhook fires on call completion. Integrated with Conversation AI and workflows.

Complete navigation structure from marketplace.gohighlevel.com/docs/ — all sections visible in the developer docs sidebar.

SectionURLStatus
Getting Started/docs/oauth/GettingStartedLive
Authorization/docs/Authorization/authorization_docLive
OAuth 2.0/docs/Authorization/OAuth2.0Live
Private Integration Token/docs/Authorization/PrivateIntegrationsTokenLive
Scopes/docs/Authorization/ScopesLive
SDK Overview/docs/SDK/sdk-overviewListed
MCP Server/docs/mcp-serverNew
AI Agent Studio/docs/ai-agent-studioNew
Knowledge Base/docs/knowledge-baseNew
Conversation AI/docs/conversation-aiNew
Voice AI/docs/voice-aiNew
Contacts/docs/ghl/contacts/contactsLive
Conversations/docs/ghl/conversations/conversationsLive
Calendars/docs/ghl/calendars/calendarsLive
Campaigns/docs/ghl/campaigns/get-campaignsLive
Opportunities/docs/ghl/opportunities/opportunitiesLive
Workflows/docs/ghl/workflows/workflowsLive
Forms/docs/ghl/forms/get-formsLive
Payments/docs/ghl/payments/integrationsLive
Webhooks (63 events)/docs/category/webhookLive
Custom Fields V2/docs/ghl/custom-fields-v2Listed
Custom Menus/docs/ghl/custom-menusListed
Brand Boards/docs/ghl/brand-boardsListed
Business/docs/ghl/businessListed
Companies/docs/ghl/companiesListed
Courses/docs/ghl/coursesListed
Email/docs/ghl/emailListed
Invoice/docs/ghl/invoiceListed
Trigger Links/docs/ghl/trigger-linksListed
Sub-Account/docs/ghl/sub-accountListed
Media Storage/docs/ghl/media-storageListed
Blogs/docs/ghl/blogsListed
Funnels/docs/ghl/funnelsListed
Products/docs/ghl/productsListed
SaaS/docs/ghl/saasListed
Snapshots/docs/ghl/snapshotsListed
Social Planner/docs/ghl/social-plannerListed
Surveys/docs/ghl/surveysListed
Users/docs/ghl/usersListed
LC Email/docs/ghl/lc-emailListed
Proposals/docs/ghl/proposalsListed
Phone System/docs/ghl/phone-systemListed
Store/docs/ghl/storeListed
Objects/docs/ghl/objectsListed
Associations/docs/ghl/associationsListed

Green = Live & scraped | Yellow = Listed in nav | Purple = New AI features (docs being built)

Generated by Builder Agent | Real Talk Agents | April 11, 2026

Source: marketplace.gohighlevel.com/docs | 4 KB articles written