The terminal for GoHighLevel. Bulk ops, dedup, and pipeline reports in seconds — local cache, agent-native JSON, multi-location support.
Every GHL feature, plus a local SQLite mirror, name->ID resolution, SQL over your contacts and opportunities, and proper handling of the lowercase-pit footgun. The first GoHighLevel CLI — built for operators who run real-estate brokerages and digital agencies and want to stop hand-rolling retry logic and stage-history scripts.
Printed by @jenwilliams-eng.
Authentication
GoHighLevel uses Private Integration Tokens (PIT). Set GHL_PIT_TOKEN in your environment (lowercase pit- prefix — capital Pit- returns 401 Invalid JWT). Optionally set GHL_LOCATION_ID for the active sub-account, or use named profiles via gohighlevel-pp-cli config use <name> to switch between locations like KWCP and THINK.
Quick Start
# verify your PIT token works and the API is reachable
gohighlevel-pp-cli doctor
# pull contacts, opportunities, pipelines, custom fields, and tags into the local SQLite cache
gohighlevel-pp-cli sync
# stage-by-stage opportunity counts, ready to paste into a Looker sheet
gohighlevel-pp-cli opp funnel --pipeline "Non-KW" --tsv
# opportunities that have not moved in 30 days, derived from local stage-transition history
gohighlevel-pp-cli opp stale --pipeline "Non-KW" --days 30 --json
# any cross-entity query becomes one SQL statement
gohighlevel-pp-cli sql "SELECT firstName, lastName, email FROM contacts WHERE tags LIKE '%recruit%' LIMIT 20" --json
Unique Features
These capabilities aren't available in any other tool for this API.
Local state that compounds
-
opp stale — Find opportunities sitting in a stage longer than N days, using synthesized stage-entry timestamps from sync history.
When the user asks 'which recruits have been sitting in this stage too long', this is the only path that resolves it without re-running their custom dashboard script.
gohighlevel-pp-cli opp stale --pipeline "Non-KW" --stage "Recruit Lead" --days 30 --json
-
opp funnel — Stage-by-stage count and total monetary value for a pipeline, output as TSV ready to paste into a dashboard sheet.
Replaces the user's Monday L10 prep script with a one-liner; the agent can re-run it on demand with different pipeline filters.
gohighlevel-pp-cli opp funnel --pipeline "Non-KW" --tsv
-
sql — Run read-only SQL against the local SQLite mirror of contacts, opportunities, pipelines, stages, tags, custom_fields, conversations, messages, and appointments.
The cross-entity differentiator. Anything an agent wants to answer about the GHL data becomes one SQL statement instead of three paginated API calls assembled in Python.
gohighlevel-pp-cli sql "SELECT name, COUNT(*) FROM opportunities GROUP BY pipelineStageId ORDER BY 2 DESC" --json
-
contact dedup — Group contacts by lowercased email and E.164 phone, score by filled-field count and recency, emit a merge plan.
Replaces a 200-line Python script the operator runs weekly. Agents can preview the merge before any data changes.
gohighlevel-pp-cli contact dedup --by email,phone --dry-run --json
-
contact decay — Find opportunities in a stage whose contacts have had no inbound or outbound messages in N days.
Catches recruits going cold before they're lost. The operator's existing alert script becomes a one-liner the agent can re-run with different thresholds.
gohighlevel-pp-cli contact decay --stage "Engaged" --idle-days 30 --json
-
recruit hot — Rank recruits by a composite of production signals, engagement, and recruit-tag count.
Monday L10 prep, before Kymber asks. Agents can re-tune the threshold without re-running the entire Python pipeline.
gohighlevel-pp-cli recruit hot --threshold 25 --tsv
-
convo thread — Reconstruct a chronological SMS+email+call thread for a single contact from the local messages table.
Before any recruit outreach, the operator wants the whole conversation in one place. Agents can read the full history without four MCP calls.
gohighlevel-pp-cli convo thread --contact jane@example.com --json
Service-specific guardrails
-
field id — Translate human-readable custom field names into opaque GHL IDs, with did-you-mean suggestions on typos.
Pair field id with sql to query contacts by custom-field value without hardcoding 20-character GHL IDs; eliminates an entire class of broken-after-rename bugs.
gohighlevel-pp-cli field id "Agent Affiliation"
-
config use — Named profiles for each GHL sub-account (KWCP, THINK), with --location flag honored across every command.
Prevents the wrong-tenant footgun. Agents can be told 'use the kwcp profile' once at session start and never think about it again.
gohighlevel-pp-cli config use kwcp && gohighlevel-pp-cli --location think opp funnel --pipeline "Non-KW"
-
doctor — Validate the PIT token (auto-lowercases the prefix), ping the active location, and report local cache state.
First command to run when anything is acting funny. Agents can call it before complex flows to short-circuit a token or cache problem.
gohighlevel-pp-cli doctor --json
Agent-native plumbing
-
contact bulk-tag — Apply or remove a tag across many contacts read from stdin, with chunked 100-at-a-time delivery and connection-drop retry.
The highest-leverage daily op for any agency — after every training, after every campaign, after every import. Without this the operator hand-rolls retry logic every time.
cat emails.csv | gohighlevel-pp-cli contact bulk-tag --tag "Attended_2026-05-19" --dry-run
Usage
Run gohighlevel-pp-cli --help for the full command reference and flag list.
Commands
calendars
Manage calendars
gohighlevel-pp-cli calendars create - Creategohighlevel-pp-cli calendars create-appointment - Create appointmentgohighlevel-pp-cli calendars delete-appointment - Delete appointmentgohighlevel-pp-cli calendars get - Getgohighlevel-pp-cli calendars get-appointment - Get appointmentgohighlevel-pp-cli calendars list - Listgohighlevel-pp-cli calendars list-events - List calendar events for a locationgohighlevel-pp-cli calendars update-appointment - Update appointment
contacts
Manage contacts
gohighlevel-pp-cli contacts bulk-update-tags - Bulk add/remove tags across many contactsgohighlevel-pp-cli contacts create - Create a contactgohighlevel-pp-cli contacts delete - Delete a contactgohighlevel-pp-cli contacts find-duplicate - Find duplicate contact by email or namegohighlevel-pp-cli contacts get - Get a contact by idgohighlevel-pp-cli contacts search - GHL's /contacts/search has a hard 100-page cap. Use the startAfter
cursor returned in the response for pagination past 10k results.
Phone search returns 500 — use email or name instead.gohighlevel-pp-cli contacts update - Update a contactgohighlevel-pp-cli contacts upsert - Upsert contact by email or phone
conversations
Manage conversations
gohighlevel-pp-cli conversations get - Getgohighlevel-pp-cli conversations search - Search conversations (Version 2021-04-15)gohighlevel-pp-cli conversations send-message - Send an SMS, email, or other message
locations
Manage locations
gohighlevel-pp-cli locations get - Getgohighlevel-pp-cli locations search - Search locations (agency-level)
opportunities
Manage opportunities
gohighlevel-pp-cli opportunities create-opportunity - Create opportunitygohighlevel-pp-cli opportunities delete-opportunity - Delete opportunitygohighlevel-pp-cli opportunities get-opportunity - Get opportunitygohighlevel-pp-cli opportunities list-pipelines - List pipelines for a locationgohighlevel-pp-cli opportunities search - Search opportunities across a pipelinegohighlevel-pp-cli opportunities update-opportunity - Update opportunitygohighlevel-pp-cli opportunities upsert-opportunity - Upsert opportunity
surveys
Manage surveys
gohighlevel-pp-cli surveys - List
users
Manage users
gohighlevel-pp-cli users get - Getgohighlevel-pp-cli users search - Search users in a location
workflows
Manage workflows
gohighlevel-pp-cli workflows - List workflows for a location
Output Formats
# Human-readable table (default in terminal, JSON when piped)
gohighlevel-pp-cli calendars list --location-id 550e8400-e29b-41d4-a716-446655440000
# JSON for scripting and agents
gohighlevel-pp-cli calendars list --location-id 550e8400-e29b-41d4-a716-446655440000 --json
# Filter to specific fields
gohighlevel-pp-cli calendars list --location-id 550e8400-e29b-41d4-a716-446655440000 --json --select id,name,status
# Dry run — show the request without sending
gohighlevel-pp-cli calendars list --location-id 550e8400-e29b-41d4-a716-446655440000 --dry-run
# Agent mode — JSON + compact + no prompts in one flag
gohighlevel-pp-cli calendars list --location-id 550e8400-e29b-41d4-a716-446655440000 --agent
Agent Usage
This CLI is designed for AI agent consumption:
- Non-interactive - never prompts, every input is a flag
- Pipeable -
--json output to stdout, errors to stderr
- Filterable -
--select id,name returns only fields you need
- Previewable -
--dry-run shows the request without sending
- Explicit retries - add
--idempotent to create retries and --ignore-missing to delete retries when a no-op success is acceptable
- Confirmable -
--yes for explicit confirmation of destructive actions
- Piped input - write commands can accept structured input when their help lists
--stdin
- Offline-friendly - sync/search commands can use the local SQLite store when available
- Agent-safe by default - no colors or formatting unless
--human-friendly is set
Exit codes: 0 success, 2 usage error, 3 not found, 4 auth error, 5 API error, 7 rate limited, 10 config error.
Health Check
gohighlevel-pp-cli doctor
Verifies configuration, credentials, and connectivity to the API.
Configuration
Config file: ~/.config/gohighlevel-pp-cli/config.toml
Static request headers can be configured under headers; per-command header overrides take precedence.
Environment variables:
| Name | Kind | Required | Description |
|---|
GHL_PIT_TOKEN | per_call | Yes | Set to your API credential. |
Troubleshooting
Authentication errors (exit code 4)
- Run
gohighlevel-pp-cli doctor to check credentials
- Verify the environment variable is set:
echo $GHL_PIT_TOKEN
Not found errors (exit code 3)
- Check the resource ID is correct
- Run the
list command to see available items
API-specific
- 401 Invalid JWT — Your PIT prefix is uppercase. Re-export the token with the lowercase prefix:
export GHL_PIT_TOKEN=pit-<uuid> (or run gohighlevel-pp-cli doctor — it auto-lowercases and warns).
- 500 error on contact search by phone — GHL's phone search returns 500. Search by email or name instead:
gohighlevel-pp-cli contact search --email jane@example.com.
- Cannot create dropdown / multi-select custom field via API — GHL does not expose this through the API. Create the field in the UI, then sync:
gohighlevel-pp-cli sync (the new field will be in the local custom_fields table).
workflow enroll silently does not fire the workflow — The contact is already enrolled in that workflow; the 'Form Submitted' trigger does not re-fire for re-enrollment. Remove first with gohighlevel-pp-cli contact unenroll <contactId> <workflowId>, then re-enroll.- Connection drops mid-sync — Re-run
gohighlevel-pp-cli sync — incremental sync resumes from the last cursor. The client uses exponential backoff with 5 retries on connection drops.
HTTP Transport
This CLI uses Chrome-compatible HTTP transport for browser-facing endpoints. It does not require a resident browser process for normal API calls.
Sources & Inspiration
This CLI was built by studying these projects and resources:
Generated by CLI Printing Press