highlevelConnect your AI assistant to GoHighLevel CRM via the official API v2. Manage contacts, conversations, calendars, pipelines, invoices, payments, workflows, an...
Install via ClawdBot CLI:
clawdbot install 10xcoldleads/highlevelTurn your AI assistant into a GoHighLevel command center. Search contacts, send messages, book appointments, manage pipelines, create invoices, schedule social posts — across all 39 GHL API v2 endpoint groups, using plain English.
Don't have GoHighLevel yet? Start with the free 5-Day AI Employee Challenge and build a fully automated system:
👉 Start the 5-Day AI Employee Challenge
| Requirement | Details |
|-------------|---------|
| Runtime | Python 3.6+ (uses only standard library: urllib, json, os, re, sys, time) |
| External packages | None — zero pip install required |
| Environment variables | HIGHLEVEL_TOKEN (Primary — your Private Integration bearer token) |
| | HIGHLEVEL_LOCATION_ID (your sub-account Location ID) |
| Network access | HTTPS to services.leadconnectorhq.com only |
Base URL: https://services.leadconnectorhq.com
Required Headers: Authorization: Bearer $HIGHLEVEL_TOKEN + Version: 2021-07-28
Rate Limits: 100 requests/10 seconds burst, 200K/day per location
All API functions use pre-defined endpoint paths — there is no arbitrary HTTP request capability. Every user-supplied ID is validated against a strict alphanumeric regex (^[a-zA-Z0-9_-]{1,128}$) before being included in any URL path, preventing path traversal and injection. The scripts use only Python's built-in urllib.request for all network calls. No shell commands, no external binaries, no file writes outside of stdout.
/highlevel-setupIf the user says "set up highlevel", "connect my GHL", or /highlevel-setup, run the setup wizard:
python3 scripts/setup-wizard.pyThe wizard automatically: checks environment variables → guides Private Integration creation → tests the connection → pulls first 5 contacts as a quick win.
| Use case | Recommended scopes |
|----------|--------------------|
| Contact management only | contacts.readonly, contacts.write |
| Contacts + messaging | Above + conversations.readonly, conversations.write, conversations/message.write |
| Full CRM (contacts, calendar, pipeline) | Above + calendars.readonly, calendars.write, opportunities.readonly, opportunities.write |
| Adding workflows & invoices | Above + workflows.readonly, invoices.readonly, invoices.write |
| Read-only reporting | contacts.readonly, opportunities.readonly, calendars.readonly, invoices.readonly, locations.readonly |
You can always add more scopes later in Settings → Private Integrations → Edit without regenerating the token.
| Feature | Agency Integration | Sub-Account Integration |
|---------|-------------------|------------------------|
| Created at | Agency Settings → Private Integrations | Sub-Account Settings → Private Integrations |
| Access scope | Agency + all sub-accounts (pass locationId) | Single location only |
| Available scopes | All scopes including locations.write, oauth., saas., snapshots.*, companies.readonly | Sub-account scopes only |
| Best for | Multi-location management, SaaS configurator | Single client integrations (recommended default) |
Recommendation: Start with a Sub-Account integration and the minimum scopes you need. You can upgrade to Agency-level later if you need multi-location access.
/location/ in app.gohighlevel.com/v2/location/{LOCATION_ID}/...export HIGHLEVEL_TOKEN="your-private-integration-token"
export HIGHLEVEL_LOCATION_ID="your-location-id"Run python3 scripts/ghl-api.py test_connection — should return location name and status.
After successful setup, pull 5 contacts as a quick win to confirm everything works.
scripts/ghl-api.py — Executable Python script (stdlib only) with built-in retry logic, pagination, input validation, and error handling.
Core Commands:
| Command | Description |
|---------|-------------|
| test_connection | Verify token + location ID work |
| search_contacts [query] | Search by name, email, or phone |
| get_contact [id] | Get full contact details |
| create_contact [json] | Create new contact |
| update_contact [id] [json] | Update contact fields |
| list_opportunities | List pipeline opportunities |
| list_conversations | List recent conversations |
| send_message [contactId] [message] | Send SMS/email |
| list_calendars | List all calendars |
| get_free_slots [calendarId] [startDate] [endDate] | Available booking slots |
| list_workflows | List all workflows |
| add_to_workflow [contactId] [workflowId] | Enroll contact in workflow |
| list_invoices | List invoices |
| list_products | List products |
| list_forms | List forms |
| list_campaigns | List campaigns |
| get_location_details | Get location info |
| list_location_tags | List location tags |
| list_courses | List courses/memberships |
All functions are safe, pre-defined endpoints. No arbitrary request capability.
The skill provides safe, specific functions for all major GHL operations. Each function maps to a specific, allowed API endpoint with validated parameters.
| # | Group | Base Path | Key Operations | Scope Prefix |
|---|-------|-----------|----------------|-------------|
| 1 | Contacts | /contacts/ | CRUD, search, upsert, tags, notes, tasks, bulk ops | contacts |
| 2 | Conversations | /conversations/ | Search, messages (SMS/email/WhatsApp/FB/IG/chat), recordings | conversations |
| 3 | Calendars | /calendars/ | CRUD, free slots, groups, resources, appointments | calendars |
| 4 | Opportunities | /opportunities/ | CRUD, search, pipelines, stages, status, followers | opportunities |
| 5 | Workflows | /workflows/ | List workflows, enroll/remove contacts | workflows |
| 6 | Campaigns | /campaigns/ | List campaigns (read-only) | campaigns |
| 7 | Invoices | /invoices/ | CRUD, send, void, record payment, Text2Pay, schedules, estimates | invoices |
| 8 | Payments | /payments/ | Orders, transactions, subscriptions, coupons, providers | payments |
| 9 | Products | /products/ | CRUD, prices, collections, reviews, store stats | products |
| 10 | Locations | /locations/ | Get/update location, custom fields, custom values, tags, templates | locations |
| | | | Custom Fields CRUD: | |
| | | | GET /locations/{id}/customFields — List | |
| | | | POST /locations/{id}/customFields — Create | |
| | | | PUT /locations/{id}/customFields/{fid} — Update | |
| | | | DELETE /locations/{id}/customFields/{fid} — Delete | |
| | | | Custom Values CRUD: | |
| | | | GET /locations/{id}/customValues — List | |
| | | | POST /locations/{id}/customValues — Create | |
| | | | PUT /locations/{id}/customValues/{vid} — Update | |
| | | | DELETE /locations/{id}/customValues/{vid} — Delete | |
| | | | Tags CRUD: | |
| | | | GET /locations/{id}/tags — List | |
| | | | POST /locations/{id}/tags — Create | |
| | | | PUT /locations/{id}/tags/{tid} — Update | |
| | | | DELETE /locations/{id}/tags/{tid} — Delete | |
| 11 | Users | /users/ | CRUD, filter by email/role | users |
| 12 | Forms | /forms/ | List forms, get submissions | forms |
| 13 | Surveys | /surveys/ | List surveys, get submissions | surveys |
| 14 | Funnels | /funnels/ | List funnels, pages, redirects | funnels |
| 15 | Social Planner | /social-media-posting/ | Posts CRUD, accounts, CSV import, categories, stats | socialplanner |
| 16 | Blogs | /blogs/ | Create/update posts, categories, authors | blogs |
| 17 | Email | /emails/ | Templates CRUD, scheduled emails | emails |
| 18 | Media | /medias/ | Upload, list, delete files | medias |
| 19 | Trigger Links | /links/ | CRUD trigger links | links |
| 20 | Businesses | /businesses/ | CRUD businesses | businesses |
| 21 | Companies | /companies/ | Get company details (Agency) | companies |
| 22 | Custom Objects | /objects/ | Schema CRUD, record CRUD | objects |
| 23 | Associations | /associations/ | CRUD associations and relations | associations |
| 24 | Proposals/Docs | /proposals/ | Documents, contracts, templates | documents_contracts |
| 25 | Snapshots | /snapshots/ | List, status, share links (Agency) | snapshots |
| 26 | SaaS | /saas/ | Subscription mgmt, plans, bulk ops (Agency $497) | saas |
| 27 | Courses | /courses/ | Import courses/memberships | courses |
| 28 | Voice AI | /voice-ai/ | Call logs, agent CRUD, actions, goals | voice-ai |
| 29 | Phone System | /phone-system/ | Phone numbers, number pools | phonenumbers |
| 30 | Custom Menus | /custom-menus/ | CRUD custom menu links (Agency) | custom-menu-link |
| 31 | OAuth | /oauth/ | Token exchange, installed locations | oauth |
| 32 | Marketplace | /marketplace/ | Installations, billing, charges | marketplace |
| 33 | Conversation AI | /conversation-ai/ | AI chatbot configuration | — |
| 34 | Knowledge Base | /knowledge-base/ | Knowledge base for AI features | — |
| 35 | AI Agent Studio | /agent-studio/ | Custom AI agent CRUD | — |
| 36 | Brand Boards | /brand-boards/ | Brand board management | — |
| 37 | Store | /store/ | E-commerce store management | — |
| 38 | LC Email | /lc-email/ | Email infrastructure (ISV) | — |
| 39 | Custom Fields | /locations/:id/customFields/ | Custom field CRUD | locations/customFields |
For detailed endpoint paths, parameters, and examples for each group:
references/contacts.md — Contact CRUD, search, tags, notes, tasks, bulk operationsreferences/conversations.md — Messaging across all channels, recordings, transcriptionsreferences/calendars.md — Calendar CRUD, free slots, appointments, groups, resourcesreferences/opportunities.md — Pipeline management, stages, status updatesreferences/invoices-payments.md — Invoices, payments, orders, subscriptions, productsreferences/locations-users.md — Location settings, custom fields/values, users, tagsreferences/social-media.md — Social planner posts, accounts, OAuth connectionsreferences/forms-surveys-funnels.md — Forms, surveys, funnels, trigger linksreferences/advanced.md — Custom objects, associations, snapshots, SaaS, Voice AI, blogs, coursesreferences/troubleshooting.md — Common errors, rate limits, token rotation, debugginglocationId parameterlimit paramstartAfter / startAfterId for large datasetsX-RateLimit-Limit-Daily, X-RateLimit-Daily-Remaining, X-RateLimit-Max, X-RateLimit-Remaining, X-RateLimit-Interval-Milliseconds50+ webhook event types for real-time notifications. Key events: ContactCreate, ContactDelete, ContactTagUpdate, InboundMessage, OutboundMessage, OpportunityCreate, OpportunityStageUpdate, OpportunityStatusUpdate, appointment events, payment events, form submission events. Webhooks continue firing even if access token expires. Config is per marketplace app.
Docs: https://marketplace.gohighlevel.com/docs/webhook/WebhookIntegrationGuide
@gohighlevel/api-client (npm) — supports privateIntegrationToken config, auto 401 retrygohighlevel-api-client (PyPI) — session storage, auto token refresh, webhook middlewareapiVersion: '2021-07-28'🌐 LaunchMyOpenClaw.com • 🌐 MyFBLeads.com
▶️ YouTube @10xcoldleads • 📘 Facebook • 💼 LinkedIn
📧 ty@10xcoldleads.com
No GoHighLevel account yet? → Start the free 5-Day AI Employee Challenge
Generated Mar 1, 2026
A real estate agency uses the skill to automatically send personalized follow-up messages to new leads captured via website forms. The AI assistant pulls contact details from GoHighLevel, checks lead status, and schedules SMS or email reminders based on lead scoring, ensuring timely engagement without manual effort.
A healthcare clinic integrates the skill to manage patient appointments through natural language commands. The AI assistant books, reschedules, or cancels calendar events in GoHighLevel, sends automated confirmation messages, and updates patient records, reducing no-shows and administrative workload.
A SaaS company employs the skill to track and update sales opportunities in their GoHighLevel pipeline. Sales reps use plain English to move deals between stages, log notes, and generate invoices, providing real-time visibility into sales performance and forecasting.
A marketing agency leverages the skill to automate client onboarding by triggering GoHighLevel workflows upon new contact creation. The AI assistant assigns tasks, sends welcome emails, and schedules kickoff calls, streamlining the process and improving client satisfaction.
A freelance consultant uses the skill to create and send invoices directly from GoHighLevel via voice or text commands. The AI assistant monitors payment statuses, sends reminders for overdue invoices, and updates financial records, ensuring consistent cash flow management.
Businesses offering monthly retainers, such as marketing agencies or SaaS providers, can use the skill to automate client communication, track subscription renewals in pipelines, and send automated invoices. This reduces manual billing tasks and enhances customer retention through timely interactions.
Companies focused on generating and converting leads, like real estate firms or coaches, utilize the skill to capture leads from websites, score them based on engagement, and trigger personalized follow-up sequences. This accelerates sales cycles and increases conversion rates by automating outreach.
Service providers such as consultants or healthcare clinics integrate the skill to manage appointments, client records, and billing processes through natural language. This streamlines operations, reduces administrative overhead, and allows for scalable service delivery with minimal staff intervention.
💬 Integration Tip
Start with a Sub-Account integration and minimal scopes like contacts and conversations to reduce complexity, then expand as needed. Use the setup wizard for guided configuration to avoid common errors.
HubSpot CRM and CMS API integration for contacts, companies, deals, owners, and content management.
Partnership outreach, market research, competitor analysis, and proposal generation. Transform your AI agent into a strategic business development partner that identifies and cultivates growth opportunities.
CRM integration, lead tracking, outreach automation, and pipeline management. Transform your AI agent into a sales assistant that never lets leads slip through the cracks.
Manage Zhihu AI Bot to publish, like/unlike, comment, delete comments, and fetch ring or comment details using Zhihu API credentials.
ActiveCampaign CRM integration for lead management, deal tracking, and email automation. Use for syncing demo leads, managing clinic sales pipeline, and triggering follow-up sequences.
Query and analyze brand mentions from Octolens API. Use when the user wants to fetch mentions, track keywords, filter by source platforms (Twitter, Reddit, GitHub, LinkedIn, etc.), sentiment analysis, or analyze social media engagement. Supports complex filtering with AND/OR logic, date ranges, follower counts, and bookmarks.