Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Connect your AI assistant to GoHighLevel CRM via the official API v2. Manage contacts, conversations, calendars, pipelines, invoices, payments, workflows, an...
Connect your AI assistant to GoHighLevel CRM via the official API v2. Manage contacts, conversations, calendars, pipelines, invoices, payments, workflows, an...
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
Turn 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
RequirementDetailsRuntimePython 3.6+ (uses only standard library: urllib, json, os, re, sys, time)External packagesNone β zero pip install requiredEnvironment variablesHIGHLEVEL_TOKEN (Primary β your Private Integration bearer token)HIGHLEVEL_LOCATION_ID (your sub-account Location ID)Network accessHTTPS 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.
If the user says "set up highlevel", "connect my GHL", or /highlevel-setup, run the setup wizard: python3 scripts/setup-wizard.py The wizard automatically: checks environment variables β guides Private Integration creation β tests the connection β pulls first 5 contacts as a quick win.
Step 1: Create a Private Integration (NOT the old API Keys method) Log into app.gohighlevel.com Switch to your Sub-Account (recommended for single-location use) Click Settings (bottom-left gear icon) Select Private Integrations in the left sidebar If not visible, enable it first: Settings β Labs β toggle Private Integrations ON Click "Create new Integration" Enter a name (e.g., "Claude AI Assistant") and description Grant only the scopes you need (least-privilege recommended): Use caseRecommended scopesContact management onlycontacts.readonly, contacts.writeContacts + messagingAbove + conversations.readonly, conversations.write, conversations/message.writeFull CRM (contacts, calendar, pipeline)Above + calendars.readonly, calendars.write, opportunities.readonly, opportunities.writeAdding workflows & invoicesAbove + workflows.readonly, invoices.readonly, invoices.writeRead-only reportingcontacts.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. Click Create β Copy the token IMMEDIATELY β it is shown only once and cannot be retrieved later Agency vs Sub-Account Integrations FeatureAgency IntegrationSub-Account IntegrationCreated atAgency Settings β Private IntegrationsSub-Account Settings β Private IntegrationsAccess scopeAgency + all sub-accounts (pass locationId)Single location onlyAvailable scopesAll scopes including locations.write, oauth.*, saas.*, snapshots.*, companies.readonlySub-account scopes onlyBest forMulti-location management, SaaS configuratorSingle 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.
While in the sub-account, go to Settings β Business Info (or Business Profile) The Location ID is displayed in the General Information section Alternative: check the URL bar β it's the ID after /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: CommandDescriptiontest_connectionVerify token + location ID worksearch_contacts [query]Search by name, email, or phoneget_contact [id]Get full contact detailscreate_contact [json]Create new contactupdate_contact [id] [json]Update contact fieldslist_opportunitiesList pipeline opportunitieslist_conversationsList recent conversationssend_message [contactId] [message]Send SMS/emaillist_calendarsList all calendarsget_free_slots [calendarId] [startDate] [endDate]Available booking slotslist_workflowsList all workflowsadd_to_workflow [contactId] [workflowId]Enroll contact in workflowlist_invoicesList invoiceslist_productsList productslist_formsList formslist_campaignsList campaignsget_location_detailsGet location infolist_location_tagsList location tagslist_coursesList 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. #GroupBase PathKey OperationsScope Prefix1Contacts/contacts/CRUD, search, upsert, tags, notes, tasks, bulk opscontacts2Conversations/conversations/Search, messages (SMS/email/WhatsApp/FB/IG/chat), recordingsconversations3Calendars/calendars/CRUD, free slots, groups, resources, appointmentscalendars4Opportunities/opportunities/CRUD, search, pipelines, stages, status, followersopportunities5Workflows/workflows/List workflows, enroll/remove contactsworkflows6Campaigns/campaigns/List campaigns (read-only)campaigns7Invoices/invoices/CRUD, send, void, record payment, Text2Pay, schedules, estimatesinvoices8Payments/payments/Orders, transactions, subscriptions, coupons, providerspayments9Products/products/CRUD, prices, collections, reviews, store statsproducts10Locations/locations/Get/update location, custom fields, custom values, tags, templateslocationsCustom Fields CRUD:GET /locations/{id}/customFields β ListPOST /locations/{id}/customFields β CreatePUT /locations/{id}/customFields/{fid} β UpdateDELETE /locations/{id}/customFields/{fid} β DeleteCustom Values CRUD:GET /locations/{id}/customValues β ListPOST /locations/{id}/customValues β CreatePUT /locations/{id}/customValues/{vid} β UpdateDELETE /locations/{id}/customValues/{vid} β DeleteTags CRUD:GET /locations/{id}/tags β ListPOST /locations/{id}/tags β CreatePUT /locations/{id}/tags/{tid} β UpdateDELETE /locations/{id}/tags/{tid} β Delete11Users/users/CRUD, filter by email/roleusers12Forms/forms/List forms, get submissionsforms13Surveys/surveys/List surveys, get submissionssurveys14Funnels/funnels/List funnels, pages, redirectsfunnels15Social Planner/social-media-posting/Posts CRUD, accounts, CSV import, categories, statssocialplanner16Blogs/blogs/Create/update posts, categories, authorsblogs17Email/emails/Templates CRUD, scheduled emailsemails18Media/medias/Upload, list, delete filesmedias19Trigger Links/links/CRUD trigger linkslinks20Businesses/businesses/CRUD businessesbusinesses21Companies/companies/Get company details (Agency)companies22Custom Objects/objects/Schema CRUD, record CRUDobjects23Associations/associations/CRUD associations and relationsassociations24Proposals/Docs/proposals/Documents, contracts, templatesdocuments_contracts25Snapshots/snapshots/List, status, share links (Agency)snapshots26SaaS/saas/Subscription mgmt, plans, bulk ops (Agency $497)saas27Courses/courses/Import courses/membershipscourses28Voice AI/voice-ai/Call logs, agent CRUD, actions, goalsvoice-ai29Phone System/phone-system/Phone numbers, number poolsphonenumbers30Custom Menus/custom-menus/CRUD custom menu links (Agency)custom-menu-link31OAuth/oauth/Token exchange, installed locationsoauth32Marketplace/marketplace/Installations, billing, chargesmarketplace33Conversation AI/conversation-ai/AI chatbot configurationβ34Knowledge Base/knowledge-base/Knowledge base for AI featuresβ35AI Agent Studio/agent-studio/Custom AI agent CRUDβ36Brand Boards/brand-boards/Brand board managementβ37Store/store/E-commerce store managementβ38LC Email/lc-email/Email infrastructure (ISV)β39Custom Fields/locations/:id/customFields/Custom field CRUDlocations/customFields
For detailed endpoint paths, parameters, and examples for each group: references/contacts.md β Contact CRUD, search, tags, notes, tasks, bulk operations references/conversations.md β Messaging across all channels, recordings, transcriptions references/calendars.md β Calendar CRUD, free slots, appointments, groups, resources references/opportunities.md β Pipeline management, stages, status updates references/invoices-payments.md β Invoices, payments, orders, subscriptions, products references/locations-users.md β Location settings, custom fields/values, users, tags references/social-media.md β Social planner posts, accounts, OAuth connections references/forms-surveys-funnels.md β Forms, surveys, funnels, trigger links references/advanced.md β Custom objects, associations, snapshots, SaaS, Voice AI, blogs, courses references/troubleshooting.md β Common errors, rate limits, token rotation, debugging
Private Integrations are required β the old Settings β API Keys method is deprecated/EOL Token rotation: Tokens don't auto-expire but GHL recommends 90-day rotation. Unused tokens auto-expire after 90 days inactivity "Rotate and expire later" β new token generated, old token stays active for 7-day grace period "Rotate and expire now" β old token invalidated immediately (use for compromised credentials) You can edit scopes without regenerating the token OAuth tokens (marketplace apps only): Access tokens expire in 24 hours (86,399s); refresh tokens last up to 1 year Agency tokens can access sub-account data by passing locationId parameter Rate limits are per-resource β each sub-account independently gets 100/10s burst + 200K/day. SaaS endpoints: 10 req/sec global All list endpoints default to 20 records, max 100 per page via limit param Use cursor pagination with startAfter / startAfterId for large datasets Monitor rate limits via response headers: X-RateLimit-Limit-Daily, X-RateLimit-Daily-Remaining, X-RateLimit-Max, X-RateLimit-Remaining, X-RateLimit-Interval-Milliseconds $497 Agency Pro plan required for: SaaS Configurator, Snapshots, full agency management APIs
50+ 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
Node.js: @gohighlevel/api-client (npm) β supports privateIntegrationToken config, auto 401 retry Python: gohighlevel-api-client (PyPI) β session storage, auto token refresh, webhook middleware PHP SDK also available All SDKs use apiVersion: '2021-07-28' OpenAPI Specs: https://github.com/GoHighLevel/highlevel-api-docs API Docs: https://marketplace.gohighlevel.com/docs/ Developer Slack: https://developers.gohighlevel.com/join-dev-community
π LaunchMyOpenClaw.com β’ π MyFBLeads.com βΆοΈ YouTube @10xcoldleads β’ π Facebook β’ πΌ LinkedIn π§ ty@10xcoldleads.com No GoHighLevel account yet? β Start the free 5-Day AI Employee Challenge
Workflow acceleration for inboxes, docs, calendars, planning, and execution loops.
Largest current source with strong distribution and engagement signals.