Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl-mcp-server-v2 — The Definitive GoHighLevel MCP Server

A spec-driven MCP server covering the full public GoHighLevel API surface: 867 unique operations (v2.1, regenerated 2026-10-28 from the live marketplace docs, 46 v3 services plus the legacy tiers). 855 tools registered; the other 12 are explicit, itemized exceptions (see api-coverage-checklist.md) — never silent omissions.

TypeScript, stdio transport, multi-tenant (locationId/companyId are call-time parameters — nothing tenant-specific is hardcoded).

Why this exists

The previous production connector (MCP_Servers/_to_delete/ghl-mcp-server-v1-retired) was a thin wrapper with silently incomplete coverage. Confirmed failures, all fixed here and locked in as regression checks (verified per-domain in docs/audits/):

Old connector failure

This server

update_opportunity dropped assignedTo, pipelineId, forecastExpectedCloseDate, forecastProbability, customFields

ghl_opportunity_update exposes all 9 documented body fields

update_contact dropped assignedTo, customFields, tags, dnd/dndSettings/inboundDndSettings, address fields, dateOfBirth, source, website, timezone

ghl_contact_update exposes all 20 documented body fields

create_task always returned 422

Root-caused: the API requires title, dueDate AND completed on create; the schema now enforces exactly that (and exposes assignedTo)

list_opportunities could never page past record 100 (ignored startAfter/startAfterId/page)

ghl_opportunity_search exposes all ~20 filter/cursor params; cursors pass through verbatim

list_media 422'd (no way to pass required type)

ghl_media_list_files requires type, altType, altId, sortBy, sortOrder per spec

Single hardcoded Version header

Version header resolved per operation from the spec that documents it (v2.1: 806 tools send v3, 28 send 2021-07-28, 21 send 2021-04-15)

Social create_post regressed

Schema verified faithful to spec; tool description carries a warning that the live endpoint had a server-side regression as of 2026-07-04

ghl_conversation_send_message 422'd on every send (fix 2026-08-26)

Upstream spec bug, not extraction loss: subType emitted as an empty object schema (live API validates a string enum — {} returned 422 CONVERSATIONS_VALIDATION_ERROR) and subType/status wrongly listed in required. Fixed via the new patchBody override layer (src/overrides/conversations.ts): both now optional strings, omitted from the outbound body when absent; required is [type, contactId]. Resolves the 2026-08-26 send failure.

12 more fields drive-wide emitted as empty object schemas (fix 2026-08-27)

Same upstream spec-bug pattern, swept and patched via patchBody: contacts dateOfBirth (create/update/upsert), associations firstObjectLabel/firstObjectKey/secondObjectLabel/secondObjectKey (create/update — these were required, so both tools were uncallable), ghl_opportunity_upsert monetaryValue (→ number), ghl_phone_purchase_number numberType (required — uncallable), ghl_product_review_bulk_update status (required — uncallable), social postType (→ enum post/story/reel), queue status, facebook account type. Registry-level regression scan now reports zero empty-object-with-scalar-example fields across all tools.

Related MCP server: ghl-mcp

Architecture — how "no silently dropped field" is guaranteed

Tools are generated from the official OpenAPI specs, not hand-transcribed:

  1. scripts/extract-operations.mjs parses every spec file, fully dereferences $refs, dedupes by METHOD + path shape — parameter names are ignored, so a spec-side rename like {id} → {emailMessageId} never duplicates or drops a tool (v3 spec variant preferred; legacy-only operations keep their legacy Version header and are flagged legacyFallback when the live v3 docs no longer list them), and emits src/generated/operations.json with request schemas verbatim.

  2. src/registry.ts builds one MCP tool per operation: path/query/header params become top-level arguments; the request body schema is carried verbatim under a body argument. Missing path-param declarations in the spec are inferred from the URL template.

  3. src/overrides/*.ts — eight domain-audit modules (one per sub-agent) carrying curated tool names, Version-header corrections, content-type overrides (multipart, form-urlencoded), body-schema patches for known-wrong specs (patchBody, added 2026-08-26 — see ghl_conversation_send_message), agency-token warnings, and the 16 skip-with-reason exceptions.

Because the schema pipeline is mechanical, a field can only be missing if it is missing from GoHighLevel's own published spec — and the three known cases of that are documented in the audits (POST /contacts/search, object-record create/update, POST /forms/upload-custom-files), each exposed with a permissive body rather than dropped.

Setup

npm install
npm run build        # tsc + copies src/generated into build/
npm start            # stdio server
npm run inspect      # MCP Inspector smoke test

Client config (e.g. Claude Desktop):

{
  "mcpServers": {
    "ghl-v2": {
      "command": "node",
      "args": ["<path>/ghl-mcp-server/build/index.js"],
      "env": { "GHL_API_KEY": "...", "GHL_ENABLE_WRITES": "false" }
    }
  }
}

Environment variables

Var

Default

Meaning

GHL_API_KEY (fallback HD_GHL_API_KEY)

—

Private-integration token / OAuth access token. Env-only, never hardcoded.

GHL_ENABLE_WRITES (fallback HD_GHL_ENABLE_WRITES)

unset = read-only

The dry-run safety gate. Unless set to true/1, every non-GET call is blocked with an explanatory error (arguments are still validated, so you can dry-run writes). Default-safe because this can point at a live CRM. POST operations that only search or list (operationId search-* / list-*, plus explicit overrides such as workflow definition validation) are treated as read-only and are not blocked.

GHL_ENABLED_DOMAINS

all

Comma-separated spec basenames (e.g. contacts,opportunities,calendars) to expose a subset of the tools — useful to keep client context small.

GHL_BASE_URL

https://services.leadconnectorhq.com

Override for testing.

GHL_TIMEOUT_MS

30000

Request timeout.

GHL_SPECS_DIR

—

Only used by npm run extract: an apps/ directory holding the legacy specs plus a v3/ folder (see Regenerating from the live docs).

GHL_ACCEPT_HEADER_CHANGES

unset

npm run extract only: set to 1 to accept Version-header drift versus the previous operations.json (the report is always written to src/generated/version-header-changes.json).

Conventions

  • Tool names: ghl_<resource>_<action> (snake_case, ≤64 chars), curated per domain (e.g. ghl_contact_update, ghl_opportunity_search, ghl_calendar_appointment_create, ghl_invoice_schedule_cancel).

  • Names are public API: src/generated/tool-names.json pins every tool name, and npm test fails if any pinned name changes or an override key matches no operation. New tools are added with npm run pin-names after review.

  • Annotations: readOnlyHint (GET and read-only POST search/list), destructiveHint (DELETE), idempotentHint (GET/PUT/DELETE), openWorldHint always true.

  • Token requirements come from each operation's spec security schemes and are stated in the tool description (Agency vs Sub-Account token, OAuth-only variants that reject Private Integration Tokens); 401/403 errors repeat the hint.

  • Rate limits: HTTP 429 is retried up to 3 times (honouring Retry-After, otherwise 2s/5s/10s); X-RateLimit-* values are returned under structuredContent.rateLimit.

  • Multi-tenant: pass locationId / companyId / altId per call. ~44 platform ops require an agency-level (Company) token — their descriptions say so.

  • Multipart uploads: pass file fields as { "filePath": "...", "filename?": "...", "mimeType?": "..." } inside body; the server builds the multipart request.

  • Responses: structuredContent = { status, ok, data } plus pretty-printed text; errors return real HTTP status + body + actionable hints.

Deliverables map

  • api-coverage-checklist.md — all 667 operations, per-row status, exceptions itemized. This is the proof of coverage.

  • docs/audits/*.md — the 8 domain audit reports (regression verifications, renames, spec bugs found).

  • docs/evaluation.xml — 10 verified evaluation Q&A pairs (mcp-builder Phase 4 format).

  • src/generated/tool-names.json — pinned tool names (path-shape key → name). docs/generated-names.json is the v2.0 historical map.

Regenerating from the live docs

The official GitHub spec repo stopped updating in June 2026; the live source is the HighLevel marketplace docs, whose per-endpoint pages each embed one OpenAPI document.

# 1. Rebuild per-service v3 specs from the docs' LLM bundle (fetches missing pages)
python3 scripts/build-v3-specs.py --fetch --root <bundle dir containing v3/llms.txt>
# 2. Assemble GHL_SPECS_DIR: legacy specs at the top, rebuilt v3 specs under v3/
# 3. Extract, review the Version-header report, then build and test
GHL_SPECS_DIR=<dir> npm run extract      # exits 2 on header drift; re-run with GHL_ACCEPT_HEADER_CHANGES=1 after review
npm run pin-names && npm test && npm run checklist

build-v3-specs.py sets operationId to the docs URL slug (the real operationId — the embedded docs carry regenerated camelCase ids that would rename tools), derives deprecated from the page heading/description, and tags each operation with its service.

Not done here (operator steps)

  • Live testing. This was a docs-driven build; no live API call was made, including for the 2.1 changes. Smoke-test read-only against a sandbox location, then enable writes deliberately. In particular, 143 operations changed their Version header to follow the live docs (see src/generated/version-header-changes.json) and none has been exercised against the live API.

  • Registering the server in a live MCP config.

  • The 12 itemized exceptions in api-coverage-checklist.md remain skipped by curated override.

Available Tools

855 tools
ghl_ad_fb_account_deleteA
DestructiveIdempotent

Delete ad account Remove a Facebook ad account connection from a location Endpoint: DELETE /ad-publishing/facebook/ad-accounts/{adAccountId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), adAccountId (required).

ghl_ad_fb_account_getB
Read-onlyIdempotent

Get ad account details Retrieve details of a specific Facebook ad account Endpoint: GET /ad-publishing/facebook/ad-accounts/{adAccountId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required), adAccountId (required).

ghl_ad_fb_account_listB
Read-onlyIdempotent

Get ad accounts Retrieve Facebook ad accounts available for the connected user Endpoint: GET /ad-publishing/facebook/ad-accounts (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), next, type, limit, +1 more.

ghl_ad_fb_ad_deleteA
DestructiveIdempotent

Delete ad Delete a Facebook ad by ID Endpoint: DELETE /ad-publishing/facebook/ads/{adId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: adId (required), body (required).

ghl_ad_fb_ad_duplicateB

Duplicate ad Duplicate an existing Facebook ad Endpoint: POST /ad-publishing/facebook/ads/{adId}/duplicate (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: adId (required), body (required).

ghl_ad_fb_ad_pauseB

Pause ad Pause a running Facebook ad Endpoint: POST /ad-publishing/facebook/ads/{adId}/pause (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: adId (required), body (required).

ghl_ad_fb_ad_resumeA

Resume ad Resume a paused Facebook ad Endpoint: POST /ad-publishing/facebook/ads/{adId}/resume (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: adId (required), body (required).

ghl_ad_fb_adset_deleteA
DestructiveIdempotent

Delete ad set Delete a Facebook ad set by ID Endpoint: DELETE /ad-publishing/facebook/adsets/{adSetId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), adSetId (required).

ghl_ad_fb_adset_duplicateB

Duplicate ad set Duplicate an existing Facebook ad set Endpoint: POST /ad-publishing/facebook/adsets/{adSetId}/duplicate (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), adSetId (required).

ghl_ad_fb_adset_pauseA

Pause ad set Pause a running Facebook ad set Endpoint: POST /ad-publishing/facebook/adsets/{adSetId}/pause (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), adSetId (required).

ghl_ad_fb_adset_resumeA

Resume ad set Resume a paused Facebook ad set Endpoint: POST /ad-publishing/facebook/adsets/{adSetId}/resume (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), adSetId (required).

ghl_ad_fb_adset_upsertB
Idempotent

Upsert adset Create or update a Facebook ad set Endpoint: PUT /ad-publishing/facebook/adsets (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_fb_ad_upsertB
Idempotent

Upsert ad Create or update a Facebook ad Endpoint: PUT /ad-publishing/facebook/ads (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_fb_audience_deleteA
DestructiveIdempotent

Delete custom audience Delete a Facebook custom audience by ID Endpoint: DELETE /ad-publishing/facebook/custom-audience/{customAudienceId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: locationId (required), customAudienceId (required).

ghl_ad_fb_audience_getA
Read-onlyIdempotent

Get custom audience by ID Retrieve one custom audience with its full detail. Returns more than the listing endpoint: Meta adds the fields relevant to the audience subtype (retentionDays and customerFileSource for customer lists, rule and pixelId for website audiences, lookalikeSpec for lookalikes), and this service appends extras describing the local smart-list or CSV source when the audience is a user-provided customer list. Endpoint: GET /ad-publishing/facebook/custom-audience/{customAudienceId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required), customAudienceId (required).

ghl_ad_fb_audience_listA
Read-onlyIdempotent

Get custom audiences Retrieve Facebook custom audiences for a location. Without limit the response is a plain array. When limit is provided (max 100) the response is a paginated { customAudiences, paging } envelope; pass after (from paging.next) to fetch the next batch. By default each item is returned in full; pass projection (comma-separated, dot-notation for nested fields, e.g. ?projection=id,name,dataSource.type) to return only the requested fields — any value outside the known field set is rejected. Endpoint: GET /ad-publishing/facebook/custom-audience (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: type (required), locationId (required), adAccountId (required), after, +3 more.

ghl_ad_fb_audience_member_addA
Idempotent

Add custom audience member Add a single contact to a Facebook custom audience. The contact is resolved from contactId and its identifiers are hashed before being sent to Meta. Use the batch endpoint for more than one member. Endpoint: PUT /ad-publishing/facebook/custom-audience/{customAudienceId}/member (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), customAudienceId (required).

ghl_ad_fb_audience_member_batch_updateA
Idempotent

Batch update audience members Add or remove members in bulk from a Facebook custom audience, sourced from a CSV or one or more smart lists — at least one of csvPath or smartlistIds is required. The work is queued rather than performed inline, so the acknowledgement confirms only that the job was accepted; nothing about the outcome is reported here. Unlike the single-member endpoints this one answers with { success: true } rather than a status-and-message body. Endpoint: PUT /ad-publishing/facebook/custom-audience/{customAudienceId}/member/batch (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), customAudienceId (required).

ghl_ad_fb_audience_member_removeA
DestructiveIdempotent

Remove custom audience member Remove a single contact from a Facebook custom audience. Note this DELETE takes a request body carrying locationId and contactId, rather than identifying the member through the path or query. Endpoint: DELETE /ad-publishing/facebook/custom-audience/{customAudienceId}/member (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), customAudienceId (required).

ghl_ad_fb_audience_updateA
Idempotent

Update custom audience Rename a Facebook custom audience or change its description. Only those two fields can be updated; membership is changed through the member endpoints. The audience is also queued for reprocessing, so the acknowledgement does not mean downstream state has caught up. Endpoint: PUT /ad-publishing/facebook/custom-audience/{customAudienceId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), customAudienceId (required).

ghl_ad_fb_campaign_deleteA
DestructiveIdempotent

Delete campaign Delete a Facebook campaign by ID Endpoint: DELETE /ad-publishing/facebook/campaigns/{campaignId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), campaignId (required).

ghl_ad_fb_campaign_duplicateB

Duplicate campaign Duplicate an existing Facebook campaign Endpoint: POST /ad-publishing/facebook/campaigns/{campaignId}/duplicate (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), campaignId (required).

ghl_ad_fb_campaign_getA
Read-onlyIdempotent

Get campaign with linked entities Retrieve a Facebook campaign with its linked adsets and ads Endpoint: GET /ad-publishing/facebook/campaign/{campaignId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: campaignId (required), locationId (required), fields, source.

ghl_ad_fb_campaign_pauseA

Pause campaign Pause a running Facebook campaign Endpoint: POST /ad-publishing/facebook/campaigns/{campaignId}/pause (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), campaignId (required).

ghl_ad_fb_campaign_publishA

Publish campaign Queue a Facebook campaign for publishing and push it live to Facebook. Publishing runs asynchronously, so the campaign comes back in the state it was queued in — publishingStatus is still DRAFT on the campaign and on every ad set and ad, and no Facebook ids are attached yet. Poll GET /facebook/campaigns/{campaignId}/publishing-progress for the outcome. Endpoint: POST /ad-publishing/facebook/campaigns/{campaignId}/publish (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), campaignId (required).

ghl_ad_fb_campaign_publishing_progress_getA
Read-onlyIdempotent

Get campaign publishing progress Returns Redis-backed publish progress for a campaign while it is publishing to Meta. Used by the validation funnel UI to poll step counts and completion state. Endpoint: GET /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: campaignId (required), locationId (required).

ghl_ad_fb_campaign_reporting_getA
Read-onlyIdempotent

Get campaign reporting Retrieve reporting for one campaign as a flat object, not the { grouped, totals } envelope the account-level report uses. Merges the locally stored campaign, Meta insights for the window, and CDP-attributed contacts. The campaign must be published — one without an fbCampaignId is rejected. Note results.lead (Meta lead actions) and leads (CDP attributed contacts) measure different things and routinely disagree. Endpoint: GET /ad-publishing/facebook/reporting/campaign/{campaignId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: endDate (required), startDate (required), campaignId (required), locationId (required).

ghl_ad_fb_campaign_resumeA

Resume campaign Resume a paused Facebook campaign Endpoint: POST /ad-publishing/facebook/campaigns/{campaignId}/resume (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), campaignId (required).

ghl_ad_fb_campaign_upsertB
Idempotent

Upsert campaign Create or update a Facebook campaign Endpoint: PUT /ad-publishing/facebook/campaigns (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_fb_conversation_form_createA

Create conversation form Create a Messenger conversation form. Note the created record is returned in its raw stored form rather than the shape the listing endpoint uses: the identifier comes back as _id instead of id, and the internal __v version key is included. Endpoint: POST /ad-publishing/facebook/conversation-forms (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_fb_conversation_form_listA
Read-onlyIdempotent

Get conversation forms Retrieve Facebook conversation lead forms for a location. Without limit the response is a plain array. When limit is provided (max 100) the response is a paginated { conversationForms, paging } envelope; pass after (from paging.next) to fetch the next batch. Endpoint: GET /ad-publishing/facebook/conversation-forms (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), after, limit.

ghl_ad_fb_current_user_getA
Read-onlyIdempotent

Get current Facebook user Retrieve the authenticated Facebook user profile for a location Endpoint: GET /ad-publishing/facebook/me (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required).

ghl_ad_fb_entity_getA
Read-onlyIdempotent

Get entities Retrieve campaigns, ad sets, or ads for a location. entityType selects which, and each returns a { data } envelope whose item shape differs — the id key is campaignId, adSetId, or adId respectively, and the status fields differ too: campaigns carry both status and effectiveStatus, ad sets only effectiveStatus, and ads only status. next is returned only when the branch pages through Meta, so treat its absence as the end of the results rather than assuming a cursor. For CAMPAIGN, type=INTEGRATION queries Meta while type=AD_MANAGER reads campaigns this service published, filtered to PAUSED and PUBLISHED. ADSET requires campaignId; AD accepts adSetId for a single ad set or campaignId to page across the campaign. Endpoint: GET /ad-publishing/facebook/entity (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: type (required), entityType (required), locationId (required), next, +5 more.

ghl_ad_fb_integration_createA

Create Facebook integration Create a Facebook ad integration for a location with page and ad account Endpoint: POST /ad-publishing/facebook/integration (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_fb_integration_deleteA
DestructiveIdempotent

Delete Facebook integration Remove the Facebook ad integration from a location Endpoint: DELETE /ad-publishing/facebook/integration (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_fb_integration_getA
Read-onlyIdempotent

Get Facebook integration Retrieve the Facebook ad integration details for a location Endpoint: GET /ad-publishing/facebook/integration (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required).

ghl_ad_fb_lead_form_getA
Read-onlyIdempotent

Get lead form by ID Retrieve a lead form by id. Pass isDraft=true to read an unpublished local draft instead, in which case leadFormId accepts either the bare id or the draft_-prefixed form the listing endpoint reports. The two branches return different shapes, and neither matches the shape the listing endpoint returns for the same form: the published branch carries the full Meta definition (context card, thank-you page, legal content) but no status, createdTime, or pageId, while the draft branch returns the stored document verbatim under _id. Endpoint: GET /ad-publishing/facebook/lead-form/{leadFormId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: leadFormId (required), locationId (required), isDraft.

ghl_ad_fb_page_deleteA
DestructiveIdempotent

Delete page connection Remove a Facebook page connection from a location. Deprecated: use DELETE /ad-publishing/facebook/pages/{pageId} with header version: v4. Endpoint: DELETE /ad-publishing/facebook/page (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: pageId (required), locationId (required).

ghl_ad_fb_page_instagram_account_listB
Read-onlyIdempotent

Get Instagram accounts for page Retrieve Instagram accounts linked to a specific Facebook page Endpoint: GET /ad-publishing/facebook/page/{pageId}/instagram (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: pageId (required), locationId (required), type.

ghl_ad_fb_page_lead_form_createA

Create page lead form Create a lead gen form. With isDraft: true the form is stored locally and returned as a draft; without it the form is published to Facebook and the Meta record is returned. The two responses share almost no fields. Publishing enforces at least one question and a complete thankYouPage (title, body, buttonText) where a draft save enforces neither. Pass draftFormId when publishing an existing draft to have it deleted afterwards — either the bare id or the draft_-prefixed form is accepted, and cleanup failures are logged rather than surfaced. Endpoint: POST /ad-publishing/facebook/page/{pageId}/forms (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), pageId (required).

ghl_ad_fb_page_lead_form_listA
Read-onlyIdempotent

Get page lead forms Retrieve lead gen forms for a specific Facebook page (published + drafts), sorted newest-first by createdTime. By default each form is returned in full (including its questions) as a plain array; pass projection (comma-separated) to return only the requested fields — any value outside the known field set is rejected. Pass limit (max 100) for a { forms, paging } envelope; use after (from paging.next) to fetch the next batch. Endpoint: GET /ad-publishing/facebook/page/{pageId}/forms (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: pageId (required), locationId (required), after, limit, +1 more.

ghl_ad_fb_page_listA
Read-onlyIdempotent

Get Facebook pages Retrieve Facebook pages for the connected account. Without limit the response is an array of pages (this array response will soon be deprecated — migrate to the paginated form). When limit is provided the response is a paginated { pages, paging } envelope; pass after (from paging.next) to fetch the next batch. Endpoint: GET /ad-publishing/facebook/pages (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), after, limit, fetchExisting.

ghl_ad_fb_page_set_defaultB
Idempotent

Set default page Set the default Facebook page for a location Endpoint: PUT /ad-publishing/facebook/page/default (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), locationId (required).

ghl_ad_fb_pixel_listA
Read-onlyIdempotent

Get conversion pixels Retrieve Facebook conversion pixels for a location. channel selects between two unrelated behaviours. For FACEBOOK (the default) the response is { items, total }, or a paginated { items, paging } envelope when limit (max 100) is given — pass after from paging.next for the next batch — and projection (comma-separated, from createdAt, fbIsCrmPixel, fbPixelCode, fbPixelId, name, type) narrows each item. For IG the response is instead a bare array of Instagram datasets carrying only an id, and limit, after, and projection are ignored. Endpoint: GET /ad-publishing/facebook/pixels (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), after, limit, pageId, +3 more.

ghl_ad_fb_pixel_upsertA
Idempotent

Upsert conversion pixel Create a Facebook conversion pixel, or rename an existing one by passing conversionPixelId. The two paths acknowledge differently: a create returns the new id, a rename returns only { success: true }. Renaming is the only update supported, and it rejects type: INSTAGRAM_DM. Creating an INSTAGRAM_DM dataset requires igUserId and fails if one already exists for that account. Endpoint: PUT /ad-publishing/facebook/pixels (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_fb_reporting_getA
Read-onlyIdempotent

Get reporting data Retrieve aggregated Facebook ad reporting metrics for a location. grouped holds one row per groupBy period, or a single row covering the whole range when groupBy is omitted, and totals aggregates across them. Both objects only carry the metrics named in fields. Be aware that ratio metrics (cpm, ctr, frequency) are summed rather than weighted in totals, and that cost_per_conversion and cost_per_result are placeholders that always read 0 — their real values live under costPerConversion and costPerResult. Endpoint: GET /ad-publishing/facebook/reporting (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: type (required), fields (required), endDate (required), startDate (required), +2 more.

ghl_ad_fb_reporting_listA
Read-onlyIdempotent

Get reporting list Retrieve campaigns, ad sets, or ads with their reporting metrics. listType selects the entity and changes the item shape; adsets and ads additionally require campaignId. Entities Meta has no insights for are still returned, padded with a fixed zero row that carries fewer fields than a real one. Note none is accepted by validation but has no handler and fails with a 409. Deprecated: use GET /ad-publishing/facebook/reporting/rows with header version: v4. Endpoint: GET /ad-publishing/facebook/reporting/list (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: type (required), endDate (required), listType (required), startDate (required), +2 more.

ghl_ad_google_account_deleteA
DestructiveIdempotent

Delete ad account Remove a Google Ads account connection from a location Endpoint: DELETE /ad-publishing/google/ad-accounts/{adAccountId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), adAccountId (required).

ghl_ad_google_account_getA
Read-onlyIdempotent

Get ad account details Retrieve details of a specific Google Ads account Endpoint: GET /ad-publishing/google/ad-accounts/{adAccountId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required), adAccountId (required).

ghl_ad_google_account_listB
Read-onlyIdempotent

Get Google ad accounts Retrieve Google Ads accounts available for the connected user Endpoint: GET /ad-publishing/google/ad-accounts (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required), type, email.

ghl_ad_google_asset_listA
Read-onlyIdempotent

Get assets Retrieve Google Ads creative assets for a location. Without limit the response is a plain array of assets. When limit is provided (max 100, default 100) the response is a paginated { assets, paging } envelope; pass pageToken (from paging.next) to fetch the next batch. Endpoint: GET /ad-publishing/google/assets (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: type (required), locationId (required), id, limit, +2 more.

ghl_ad_google_asset_upsertB

Upsert assets Create or update Google Ads creative assets Endpoint: POST /ad-publishing/google/assets (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_google_audience_getA
Read-onlyIdempotent

Get audience by ID Retrieve a specific Google Ads combined audience by ID Endpoint: GET /ad-publishing/google/audiences/{audienceId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: audienceId (required), locationId (required).

ghl_ad_google_audience_listA
Read-onlyIdempotent

Get audiences Retrieve Google Ads combined audiences for a location. Without limit the response is a plain array. When limit is provided (max 100, default 100) the response is a paginated { audiences, paging } envelope; pass pageToken (from paging.next) to fetch the next batch. Endpoint: GET /ad-publishing/google/audiences (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), limit, pageToken.

ghl_ad_google_audience_upsertB
Idempotent

Upsert audience Create or update a Google Ads combined audience Endpoint: PUT /ad-publishing/google/audiences (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_google_campaign_getB
Read-onlyIdempotent

Get Google campaign by ID Retrieve a specific Google Ads campaign by ID Endpoint: GET /ad-publishing/google/ads/{adId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: adId (required), locationId (required).

ghl_ad_google_campaign_publishB

Publish ad Publish a Google ad and push it live Endpoint: POST /ad-publishing/google/ads/{adId}/publish (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: adId (required), body (required).

ghl_ad_google_campaign_reporting_getB
Read-onlyIdempotent

Get campaign reporting Retrieve reporting metrics for a specific Google campaign Endpoint: GET /ad-publishing/google/reporting/campaign/{campaignId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: endDate (required), startDate (required), campaignId (required), locationId (required).

ghl_ad_google_campaign_upsertB
Idempotent

Upsert Google campaign Create or update a full Google Ads campaign structure Endpoint: PUT /ad-publishing/google/ads (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_google_conversion_deleteA
DestructiveIdempotent

Delete conversion Delete a Google Ads conversion action by ID Endpoint: DELETE /ad-publishing/google/conversions/{conversionId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: locationId (required), conversionId (required).

ghl_ad_google_conversion_getA
Read-onlyIdempotent

Get conversion by ID Retrieve a specific Google Ads conversion action by ID Endpoint: GET /ad-publishing/google/conversions/{conversionId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required), conversionId (required).

ghl_ad_google_conversion_goal_listA
Read-onlyIdempotent

Get conversion goals Retrieve Google Ads conversion goals for a location. Without limit the response is a plain array. When limit is provided (max 100, default 100) the response is a paginated { conversionGoals, paging } envelope; pass pageToken (from paging.next) to fetch the next batch. Endpoint: GET /ad-publishing/google/conversion-goals (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), limit, pageToken.

ghl_ad_google_conversion_listA
Read-onlyIdempotent

Get conversions Retrieve Google Ads conversion actions for a location. The response shape is selected by type. When type is AD_MANAGER: without limit a plain array of full conversion actions, and with limit (max 100, default 100) a paginated { conversions, paging } envelope — pass pageToken (from paging.next) for the next batch. When type is omitted or AD_WORDS, a different, minimal snake_case projection is returned and limit, pageToken, startDate, endDate, conversionType and category are all ignored. Endpoint: GET /ad-publishing/google/conversions (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), type, limit, endDate, +4 more.

ghl_ad_google_conversion_upsertA
Idempotent

Upsert conversion Create or update a Google Ads conversion action Endpoint: PUT /ad-publishing/google/conversions (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_google_current_user_getA
Read-onlyIdempotent

Get current Google user Retrieve the authenticated Google user info for a location Endpoint: GET /ad-publishing/google/me (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required).

ghl_ad_google_entity_getB
Read-onlyIdempotent

Get entities Retrieve Google campaigns, ad groups, or ads based on entity type Endpoint: GET /ad-publishing/google/entity (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: type (required), entityType (required), locationId (required), endDate, +5 more.

ghl_ad_google_get_publishing_progressA
Read-onlyIdempotent

Get ad publishing progress Returns Redis-backed publish progress for a Google campaign while it is publishing. Used by the publish progress UI to poll step counts and completion state. Endpoint: GET /ad-publishing/google/ads/{adId}/publishing-progress (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: adId (required), locationId (required).

ghl_ad_google_integration_createB

Create Google integration Create a Google Ads integration for a location Endpoint: POST /ad-publishing/google/integration (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_google_integration_getA
Read-onlyIdempotent

Get Google integration Retrieve the Google Ads integration details for a location Endpoint: GET /ad-publishing/google/integration (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required).

ghl_ad_google_keyword_ideas_getB

Get keyword ideas Retrieve keyword suggestions for Google Ads campaigns Endpoint: POST /ad-publishing/google/keyword-ideas (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: body (required), locationId (required).

ghl_ad_google_reporting_getB
Read-onlyIdempotent

Get reporting data Retrieve aggregated Google Ads reporting metrics for a location Endpoint: GET /ad-publishing/google/reporting (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: type (required), fields (required), endDate (required), startDate (required), +2 more.

ghl_ad_google_reporting_listA
Read-onlyIdempotent

Get reporting list Retrieve a list of Google campaigns or ad groups with reporting data. Deprecated: use GET /ad-publishing/google/reporting/rows with header version: v4. Endpoint: GET /ad-publishing/google/reporting/list (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: type (required), endDate (required), listType (required), startDate (required), +2 more.

ghl_ad_google_segment_deleteB
DestructiveIdempotent

Delete segment Delete a Google Ads audience segment by ID Endpoint: DELETE /ad-publishing/google/segments/{segmentId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: type (required), segmentId (required), locationId (required).

ghl_ad_google_segment_getA
Read-onlyIdempotent

Get segment by ID Retrieve a specific Google Ads audience segment by ID Endpoint: GET /ad-publishing/google/segments/{segmentId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: type (required), segmentId (required), locationId (required).

ghl_ad_google_segment_listA
Read-onlyIdempotent

Get segments Retrieve Google Ads audience segments for a location. Without limit the response is a plain array. When limit is provided (max 100, default 100) the response is a paginated { segments, paging } envelope; pass pageToken (from paging.next) to fetch the next batch. Endpoint: GET /ad-publishing/google/segments (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), type, limit, pageToken.

ghl_ad_google_segment_offline_job_createB

Create offline user list job Create a job to upload users to a Google customer match list Endpoint: POST /ad-publishing/google/segments/offline-user-list-job (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_google_segment_upsertB
Idempotent

Upsert segment Create or update a Google Ads audience segment Endpoint: PUT /ad-publishing/google/segments (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), type (required), locationId (required).

ghl_ad_google_target_interest_listA
Read-onlyIdempotent

Get target interests Retrieve affinity and in-market audience options for Google Ads targeting. Without limit the response is a plain array of root interests (each with a nested children tree). When limit is provided (max 100) the response is a paginated { targetInterests, paging } envelope — a page counts root interests; pass pageToken (from paging.next) to fetch the next batch. By default each node is returned in full; pass projection (comma-separated, e.g. ?projection=name,userInterestId,children) to return only the requested fields — selecting children prunes the whole tree recursively with the same selection, and any value outside the known field set is rejected. Endpoint: GET /ad-publishing/google/target-interests (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: type (required), locationId (required), advertisingChannelType (required), limit, +2 more.

ghl_ad_li_account_deleteA
DestructiveIdempotent

Delete ad account Remove a LinkedIn ad account connection from a location. Deprecated: use DELETE /ad-publishing/linkedin/ad-accounts/{adAccountId} with header version: v4. Endpoint: DELETE /ad-publishing/linkedin/ad-account (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: locationId (required), adAccountId (required).

ghl_ad_li_account_getA
Read-onlyIdempotent

Get ad account details Retrieve details of a specific LinkedIn ad account. Deprecated: use GET /ad-publishing/linkedin/ad-accounts/{adAccountId} with header version: v4. Endpoint: GET /ad-publishing/linkedin/ad-account (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required), adAccountId (required).

ghl_ad_li_account_listA
Read-onlyIdempotent

Get LinkedIn ad accounts Retrieve LinkedIn Ads accounts available for the connected user Endpoint: GET /ad-publishing/linkedin/ad-accounts (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required).

ghl_ad_li_ad_status_updateA

Update ad status Pause or resume a LinkedIn ad, campaign, or ad group. Deprecated: use PATCH /ad-publishing/linkedin/ads/{adId}/status with header version: v4. Endpoint: PATCH /ad-publishing/linkedin/{adId}/status (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: adId (required), body (required), locationId (required).

ghl_ad_li_campaign_group_getA
Read-onlyIdempotent

Get ad campaign group Retrieve a LinkedIn ad campaign group by ID Endpoint: GET /ad-publishing/linkedin/ads/{adId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: adId (required), locationId (required).

ghl_ad_li_campaign_group_publishB

Publish ad campaign group Publish a LinkedIn ad campaign group and push it live Endpoint: POST /ad-publishing/linkedin/ads/{adId}/publish (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: adId (required), body (required).

ghl_ad_li_campaign_group_reporting_getA
Read-onlyIdempotent

Get campaign group reporting Retrieve reporting metrics for a specific LinkedIn campaign group Endpoint: GET /ad-publishing/linkedin/reporting/campaign-group/{campaignGroupId} (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: endDate (required), startDate (required), locationId (required), campaignGroupId (required), +1 more.

ghl_ad_li_campaign_group_upsertA
Idempotent

Upsert ad campaign group Create or update a LinkedIn ad campaign group with campaigns and ads Endpoint: PUT /ad-publishing/linkedin/ads (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_li_current_user_getA
Read-onlyIdempotent

Get current LinkedIn user Retrieve the authenticated LinkedIn user info for a location Endpoint: GET /ad-publishing/linkedin/me (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required).

ghl_ad_li_integration_createA

Create LinkedIn integration Create a LinkedIn Ads integration for a location with ad account details Endpoint: POST /ad-publishing/linkedin/integration (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required).

ghl_ad_li_integration_getA
Read-onlyIdempotent

Get LinkedIn integration Retrieve the LinkedIn Ads integration details for a location Endpoint: GET /ad-publishing/linkedin/integration (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: locationId (required).

ghl_ad_li_lead_form_createA

Create lead form Create a new LinkedIn lead gen form for an ad account. Deprecated: use POST /ad-publishing/linkedin/accounts/{accountId}/form with header version: v4. Endpoint: POST /ad-publishing/linkedin/{accountId}/form (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.write

Inputs: body (required), accountId (required), locationId (required).

ghl_ad_li_lead_form_listA
Read-onlyIdempotent

Get lead forms Retrieve LinkedIn lead gen forms for an ad account. By default each form is returned in full as a plain array; pass projection (comma-separated, dot-notation for nested fields) to return only the requested fields — any value outside the known field set is rejected. When limit is provided (max 100) the response is a paginated { leadForms, paging } envelope; pass pageToken (from paging.next) to fetch the next batch. Deprecated: use GET /ad-publishing/linkedin/accounts/{accountId}/forms with header version: v4. Endpoint: GET /ad-publishing/linkedin/{accountId}/forms (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: accountId (required), locationId (required), limit, pageToken, +1 more.

ghl_ad_li_reporting_getA
Read-onlyIdempotent

Get ad analytics Retrieve LinkedIn Ads analytics data with configurable pivot and time grouping Endpoint: GET /ad-publishing/linkedin/reporting (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: endDate (required), startDate (required), locationId (required), pivot, +3 more.

ghl_ad_li_reporting_listA
Read-onlyIdempotent

Get reporting list Retrieve a list of LinkedIn campaigns or campaign groups with reporting data. Deprecated: use GET /ad-publishing/linkedin/reporting/rows with header version: v4. Endpoint: GET /ad-publishing/linkedin/reporting/list (Version header: v3; source: v3/ad-publishing-v3.json) OAuth scopes: adPublishing.readonly

Inputs: endDate (required), listType (required), startDate (required), campaignId (required), +3 more.

ghl_affiliate_commission_listA
Read-onlyIdempotent

List Commissions Retrieve the list of commissions for a location. Endpoint: GET /affiliate-manager/{locationId}/commissions (Version header: v3; source: v3/affiliate-manager-v3.json) OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, query, +5 more.

ghl_affiliate_createA

Create Affiliate Create an affiliate for a location. An affiliate already registered with the same email in this location is updated instead of duplicated. Endpoint: POST /affiliate-manager/{locationId}/affiliates (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required).

ghl_affiliate_create_commissionA

Create commission Create a manual commission for a customer. Endpoint: POST /affiliate-manager/{locationId}/commission (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required).

ghl_affiliate_create_customer_leadA

Create customer lead Create or update a lead for an affiliate customer. Endpoint: POST /affiliate-manager/{locationId}/affiliates/{affiliateId}/lead/create (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), affiliateId (required).

ghl_affiliate_create_payout_methodA

Create Payout Method Store a payout method for an affiliate. An affiliate can hold one PayPal and one bank method; the first method stored becomes the primary one. Bank fields are validated against the requirements of the account country. Endpoint: POST /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), affiliateId (required).

ghl_affiliate_delete_commissionA
DestructiveIdempotent

Delete commission Delete a commission and update its associated payout. Endpoint: DELETE /affiliate-manager/{locationId}/commission/{commissionId} (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: locationId (required), commissionId (required).

ghl_affiliate_delete_customerA
DestructiveIdempotent

Delete customer Delete a lead or customer for an affiliate. Endpoint: DELETE /affiliate-manager/{locationId}/affiliates/{affiliateId}/customer/{customerId} (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: customerId (required), locationId (required), affiliateId (required).

ghl_affiliate_delete_mediaA
DestructiveIdempotent

Delete affiliate media Delete a media file or folder for a location. Endpoint: DELETE /affiliate-manager/{locationId}/media/{mediaId} (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: mediaId (required), locationId (required).

ghl_affiliate_delete_payout_methodA
DestructiveIdempotent

Delete Payout Method Delete a payout method. The primary method cannot be deleted while the affiliate holds more than one. Endpoint: DELETE /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId} (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: locationId (required), affiliateId (required), payoutMethodId (required).

ghl_affiliate_deny_commissionA
Idempotent

Deny commission Deny a commission and move its payout to denied status. Endpoint: PUT /affiliate-manager/{locationId}/commission/{commissionId}/deny (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: locationId (required), commissionId (required).

ghl_affiliate_getA
Read-onlyIdempotent

Get Affiliate Retrieve a single affiliate by id for a location. Endpoint: GET /affiliate-manager/{locationId}/affiliates/{affiliateId} (Version header: v3; source: v3/affiliate-manager-v3.json) OAuth scopes: affiliate-manager.readonly

Inputs: locationId (required), affiliateId (required).

ghl_affiliate_get_campaignA
Read-onlyIdempotent

Get Campaign Retrieve a single affiliate campaign by id for a location. Endpoint: GET /affiliate-manager/{locationId}/campaigns/{campaignId} (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly

Inputs: campaignId (required), locationId (required).

ghl_affiliate_listA
Read-onlyIdempotent

List Affiliates Retrieve the list of affiliates for a location. Endpoint: GET /affiliate-manager/{locationId}/affiliates (Version header: v3; source: v3/affiliate-manager-v3.json) OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, query, +4 more.

ghl_affiliate_list_campaignsA
Read-onlyIdempotent

List Campaigns Retrieve the list of affiliate campaigns for a location. Endpoint: GET /affiliate-manager/{locationId}/campaigns (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, query, +2 more.

ghl_affiliate_list_country_bank_mappingsA
Read-onlyIdempotent

List Country Bank Mappings List the bank fields each supported country requires, for building a bank payout method. This is shared reference data, identical for every location. Endpoint: GET /affiliate-manager/{locationId}/country-bank-mapping (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly

Inputs: locationId (required).

ghl_affiliate_list_customersA
Read-onlyIdempotent

List customers Retrieve the list of customers for an affiliate. Endpoint: GET /affiliate-manager/{locationId}/affiliates/{affiliateId}/customers (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), affiliateId (required), skip, limit, +4 more.

ghl_affiliate_list_mediaA
Read-onlyIdempotent

List affiliate media Retrieve media files and folders for a location. Endpoint: GET /affiliate-manager/{locationId}/media (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, query, +5 more.

ghl_affiliate_list_payout_methodsA
Read-onlyIdempotent

List Payout Methods List the payout methods stored for an affiliate. Bank account values are returned as their last four characters only. Endpoint: GET /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), affiliateId (required), skip, limit.

ghl_affiliate_mark_payout_method_primaryA

Mark Payout Method As Primary Make this payout method the one payouts default to. Any other method stops being primary. Endpoint: PATCH /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId}/primary (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: locationId (required), affiliateId (required), payoutMethodId (required).

ghl_affiliate_move_campaignA

Move Affiliate To Campaign Move an affiliate from one campaign to another. The target campaign must be live and belong to the same location, and the affiliate must not already be enrolled in it. Endpoint: POST /affiliate-manager/affiliate-campaign/{locationId}/affiliate/{affiliateId}/move-campaign (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), affiliateId (required).

ghl_affiliate_payout_listA
Read-onlyIdempotent

List Payouts Retrieve the list of payouts for a location. Endpoint: GET /affiliate-manager/{locationId}/payouts (Version header: v3; source: v3/affiliate-manager-v3.json) OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), end, skip, limit, +5 more.

ghl_affiliate_updateA
Idempotent

Update Affiliate Replace an affiliate for a location. Fields omitted from the body are cleared, so send the complete affiliate. Endpoint: PUT /affiliate-manager/{locationId}/affiliates/{affiliateId} (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), affiliateId (required).

ghl_affiliate_update_commission_statusA
Idempotent

Update commission status Update the status of a commission and its associated payout. Endpoint: PUT /affiliate-manager/{locationId}/commission/{commissionId}/status (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), commissionId (required).

ghl_affiliate_update_customer_stateA

Update customer state Update the disabled state of a customer for an affiliate. Endpoint: PATCH /affiliate-manager/{locationId}/affiliates/{affiliateId}/customers/{customerId}/state (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), customerId (required), locationId (required), affiliateId (required).

ghl_affiliate_update_mediaA
Idempotent

Update affiliate media Update a media file or folder for a location. Endpoint: PUT /affiliate-manager/{locationId}/media/{mediaId} (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), mediaId (required), locationId (required).

ghl_affiliate_update_payout_methodA
Idempotent

Update Payout Method Replace the stored details of a payout method. The payout method type cannot be changed, and the method must belong to the affiliate named in the path. Endpoint: PUT /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId} (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), affiliateId (required), payoutMethodId (required).

ghl_affiliate_update_referral_idA
Idempotent

Update Affiliate Referral Id Set the referral id an affiliate is tracked by on a campaign. The referral link is rebuilt around the new id, and the id must be unused across the location. Endpoint: PUT /affiliate-manager/affiliate-campaign/{locationId}/affiliate/{affiliateId}/referral-id (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), affiliateId (required).

ghl_affiliate_update_statusA
Idempotent

Update Affiliate Status Activate or deactivate an affiliate. Sending the same value again leaves the affiliate unchanged. Endpoint: PUT /affiliate-manager/{locationId}/affiliates/{affiliateId}/status (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), affiliateId (required).

ghl_affiliate_update_suspensionA
Idempotent

Update Affiliate Suspension Suspend or reinstate an affiliate on a campaign. Suspending cancels their pending and denied payouts, commissions and transactions; reinstating returns cancelled ones to pending. Endpoint: PUT /affiliate-manager/affiliate-campaign/{locationId}/campaign/{campaignId}/affiliate/{affiliateId}/suspension (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), campaignId (required), locationId (required), affiliateId (required).

ghl_affiliate_upload_tax_formA

Upload affiliate tax form Upload a W-8 or W-9 document for an affiliate. Send the document as multipart/form-data; the storage location is assigned by the server. Endpoint: POST /affiliate-manager/{locationId}/affiliates/{affiliateId}/tax-form (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.write

Inputs: body (required), locationId (required), affiliateId (required).

ghl_affiliate_validate_customer_leadA
Read-onlyIdempotent

Validate customer lead Check whether a lead already exists for an affiliate customer. Endpoint: GET /affiliate-manager/{locationId}/affiliates/{affiliateId}/lead/validate (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly

Inputs: email (required), campaignId (required), locationId (required), affiliateId (required).

ghl_affiliate_validate_referral_idA
Read-onlyIdempotent

Validate Referral Id Check whether a referral id is free to use. Referral ids are unique across a location, so a taken id reports as unavailable even when it belongs to a different campaign. Endpoint: GET /affiliate-manager/affiliate-campaign/{locationId}/referral-id/validate (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly

Inputs: locationId (required), referralId (required).

ghl_agent_studio_createA

Create Agent Creates a new agent with staging version. The agent will be created with an initial staging version that can later be promoted to production. Endpoint: POST /agent-studio/agent (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write

Inputs: body (required), source.

ghl_agent_studio_deleteA
DestructiveIdempotent

Delete Agent Deletes an agent and all its versions. Endpoint: DELETE /agent-studio/agent/{agentId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write

Inputs: agentId (required), locationId (required), source.

ghl_agent_studio_executeA

Execute Agent Executes the specified agent and returns a non-streaming JSON response with the complete agent output. The agent must be in active status and belong to the specified location. locationId is required in the request body.

Session Management:

  • For the first message in a new session, do not include the executionId in the request payload.

  • The API will return an executionId along with the agent response, which uniquely identifies this conversation session.

  • To continue the conversation within the same session, include the executionId from the previous response in subsequent requests. This allows the agent to maintain conversation context and history across multiple interactions. Endpoint: POST /agent-studio/agent/{agentId}/execute (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write

Inputs: body (required), agentId (required), source.

ghl_agent_studio_execute_deprecatedA

Deprecated per official spec — use ghl_agent_studio_execute (POST /agent-studio/agent/{agentId}/execute) instead. [DEPRECATED per official docs — prefer the documented replacement if one exists.] Execute Agent (Deprecated) Deprecated endpoint - use POST /agent/:agentId/execute instead.

Executes the specified agent and returns a non-streaming JSON response with the complete agent output. The agent must be in active status and belong to the specified location. locationId is required in the request body.

Session Management:

  • For the first message in a new session, do not include the executionId in the request payload.

  • The API will return an executionId along with the agent response, which uniquely identifies this conversation session.

  • To continue the conversation within the same session, include the executionId from the previous response in subsequent requests. Endpoint: POST /agent-studio/public-api/agents/{agentId}/execute (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write

Inputs: body (required), agentId (required), source.

ghl_agent_studio_execute_managedA

Execute a published Managed Agent Runs one JSON turn against the published production snapshot. Omit sessionId on the first turn and pass the returned sessionId on subsequent turns. Reuse the same Idempotency-Key only when retrying the exact same logical turn. For a 429 response, retry that key only when retryable is true and Retry-After is present. Endpoint: POST /agent-studio/managed-agents/{managedAgentId}/execute (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: managed-agents.write

Inputs: body (required), managedAgentId (required), Idempotency-Key (required).

ghl_agent_studio_get_by_idA
Read-onlyIdempotent

Get Agent Gets a specific agent by its ID for the specified location with all its versions. Returns complete agent metadata and all non-deleted versions (draft, staging, production). locationId is required parameter. The agent must have active status. Endpoint: GET /agent-studio/agent/{agentId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.readonly

Inputs: agentId (required), locationId (required), source.

ghl_agent_studio_get_by_id_deprecatedA
Read-onlyIdempotent

Deprecated per official spec — use ghl_agent_studio_get_by_id (GET /agent-studio/agent/{agentId}) instead. [DEPRECATED per official docs — prefer the documented replacement if one exists.] Get Agent (Deprecated) Deprecated endpoint - use GET /agent/:agentId instead.

Gets a specific agent by its ID for the specified location with all its versions. locationId is required parameter. The agent must have active status. Endpoint: GET /agent-studio/public-api/agents/{agentId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.readonly

Inputs: agentId (required), locationId (required), source.

ghl_agent_studio_get_managedA
Read-onlyIdempotent

Get a published Managed Agent Returns public metadata for a published production Managed Agent. Unknown, unpublished, and cross-location identifiers return 404. Endpoint: GET /agent-studio/managed-agents/{managedAgentId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: managed-agents.readonly

Inputs: locationId (required), managedAgentId (required).

ghl_agent_studio_listA
Read-onlyIdempotent

Lists agents (paginated via limit/offset) — not a get-by-id lookup. List Agents Lists all active agents for the specified location. locationId is required parameter to ensure optimal performance. Supports pagination using limit and offset. Optionally filter by isPublished=true to return only agents with a published production version. Endpoint: GET /agent-studio/agent (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: limit (required), offset (required), locationId (required), source, +1 more.

ghl_agent_studio_list_deprecatedA
Read-onlyIdempotent

Deprecated per official spec — use ghl_agent_studio_list (GET /agent-studio/agent) instead. [DEPRECATED per official docs — prefer the documented replacement if one exists.] List Agents (Deprecated) Deprecated endpoint - use GET /agent instead.

Lists all active agents that have a published production version for the specified location. locationId is required parameter. Supports pagination using limit and offset. Endpoint: GET /agent-studio/public-api/agents (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: limit (required), offset (required), locationId (required), source.

ghl_agent_studio_list_managedA
Read-onlyIdempotent

List published Managed Agents Returns only Managed Agents with a published production version in the authorized sub-account. Endpoint: GET /agent-studio/managed-agents (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: managed-agents.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, query.

ghl_agent_studio_promote_and_publishB

Promote to Production Promotes a draft version to production. Endpoint: POST /agent-studio/agent/versions/{versionId}/publish (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write

Inputs: body (required), versionId (required), source.

ghl_agent_studio_update_metadataA

Update Agent Metadata Updates agent metadata such as name, description, and status. Endpoint: PATCH /agent-studio/agent/{agentId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write

Inputs: body (required), agentId (required), source.

ghl_agent_studio_update_versionA

Update Agent Updates a specific agent version by versionId. Supports updating nodes, edges, variables, and configuration. Endpoint: PATCH /agent-studio/agent/versions/{versionId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write

Inputs: body (required), versionId (required), source.

ghl_association_createB

Create Association Allow you to create contact - contact , contact - custom objects and business - contact associations, will add more in the future.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3 Endpoint: POST /associations/ (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations.write

Inputs: body (required).

ghl_association_create_relationC

Create Relation for you associated entities. Create Relation.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3 Endpoint: POST /associations/relations (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations/relation.write

Inputs: body (required).

ghl_association_deleteB
DestructiveIdempotent

Delete Association Delete USER_DEFINED Association By Id, deleting an association will also all the relations for that association Endpoint: DELETE /associations/{associationId} (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations.write

Inputs: associationId (required).

ghl_association_delete_relationC
DestructiveIdempotent

Delete Relation Endpoint: DELETE /associations/relations/{relationId} (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations/relation.write

Inputs: locationId (required), relationId (required).

ghl_association_get_by_idA
Read-onlyIdempotent

Get association by ID Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id Endpoint: GET /associations/{associationId} (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations.readonly

Inputs: associationId (required).

ghl_association_get_by_key_nameC
Read-onlyIdempotent

Renamed from the auto-generated 'ghl_association_get_key_by_key_name' (redundant 'key_by_key_name'). Get association key by key name Using this api you can get standard / user defined association by key Endpoint: GET /associations/key/{key_name} (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations.readonly

Inputs: key_name (required), locationId (required).

ghl_association_get_by_object_keyC
Read-onlyIdempotent

Renamed from the auto-generated 'ghl_association_get_by_object_keys' — singular to match the single objectKey path param (plural 'keys' was misleading, it's one key per call). Get association by object keys Get association by object keys like contacts, custom objects and opportunities. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3 Endpoint: GET /associations/objectKey/{objectKey} (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations.readonly

Inputs: objectKey (required), locationId.

ghl_association_get_relations_by_record_idB
Read-onlyIdempotent

Get all relations By record Id Get all relations by record Id Endpoint: GET /associations/relations/{recordId} (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations/relation.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: skip (required), limit (required), recordId (required), locationId (required), +1 more.

ghl_association_listA
Read-onlyIdempotent

Renamed from the auto-generated 'ghl_association_find' for consistency with other domain list-operation names. Get all associations for a sub-account / location Get all Associations Endpoint: GET /associations/ (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: skip (required), limit (required), locationId (required).

ghl_association_updateB
Idempotent

Update Association By Id Update Association , Allows you to update labels of an associations. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3 Endpoint: PUT /associations/{associationId} (Version header: v3; source: v3/associations-v3.json) OAuth scopes: associations.write

Inputs: body (required), associationId (required).

ghl_blog_check_url_slug_existsA
Read-onlyIdempotent

Check url slug The "Check url slug" API checks whether a blog post url slug is already in use for the location. Call it before publishing a blog post. Endpoint: GET /blogs/posts/url-slug-exists (Version header: v3; source: v3/blogs-v3.json) Requires a Sub-Account (location) token. OAuth scopes: blogs/check-slug.readonly

Inputs: urlSlug (required), locationId (required), postId.

ghl_blog_get_all_authors_by_locationA
Read-onlyIdempotent

Get all blog authors The "Get all blog authors" API returns the blog authors for a given location ID. Endpoint: GET /blogs/authors (Version header: v3; source: v3/blogs-v3.json) Requires a Sub-Account (location) token. OAuth scopes: blogs/author.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: limit (required), offset (required), locationId (required), searchTerm.

ghl_blog_get_all_categories_by_locationA
Read-onlyIdempotent

Get all blog categories The "Get all blog categories" API returns the blog categories for a given location ID. Endpoint: GET /blogs/categories (Version header: v3; source: v3/blogs-v3.json) Requires a Sub-Account (location) token. OAuth scopes: blogs/category.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: limit (required), offset (required), locationId (required), searchTerm.

ghl_blog_get_post_by_idA
Read-onlyIdempotent

Get Blog Post by ID The "Get Blog Post by ID" API returns a single published blog post, including its content/body, for the given location. Endpoint: GET /blogs/posts/post/{postId} (Version header: v3; source: v3/blogs-v3.json) Requires a Sub-Account (location) token. OAuth scopes: blogs/posts.readonly

Inputs: postId (required), locationId (required).

ghl_blog_post_createA

Create Blog Post The "Create Blog Post" API allows you to create a blog post for any given blog site. Endpoint: POST /blogs/posts (Version header: v3; source: v3/blogs-v3.json) Requires a Sub-Account (location) token. OAuth scopes: blogs/post.write

Inputs: body (required).

ghl_blog_post_listA
Read-onlyIdempotent

Lists all posts for a given blogId (operationId get-blog-post) — not a single-post fetch. Requires blogId + limit; paginated. Get Blog posts by Blog ID The "Get Blog posts by Blog ID" API returns the blog posts for a given blog site. Use searchTerm to search across post title, description, url slug and category name. Endpoint: GET /blogs/posts/all (Version header: v3; source: v3/blogs-v3.json) Requires a Sub-Account (location) token. OAuth scopes: blogs/posts.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: limit (required), blogId (required), offset (required), locationId (required), +2 more.

ghl_blog_site_listA
Read-onlyIdempotent

Get Blogs by Location ID The "Get Blogs by Location ID" API allows you get blogs using Location ID. Endpoint: GET /blogs/site/all (Version header: v3; source: v3/blogs-v3.json) Requires a Sub-Account (location) token. OAuth scopes: blogs/list.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, searchTerm.

ghl_blog_update_postA
Idempotent

Update Blog Post The "Update Blog Post" API updates an existing blog post for any given blog site. Endpoint: PUT /blogs/posts/{postId} (Version header: v3; source: v3/blogs-v3.json) Requires a Sub-Account (location) token. OAuth scopes: blogs/post-update.write

Inputs: body (required), postId (required).

ghl_brand_board_createA

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Create a new brand board Creates a new brand board with logos, colors, and fonts Endpoint: POST /brand-boards/ (Version header: 2021-07-28; source: brand-boards.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.write

Inputs: body (required).

ghl_brand_board_create_design_kitA

Create Design Kit Create a design kit for a location Endpoint: POST /brand-boards/locations/{locationId}/design-kits (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.write

Inputs: body (required), locationId (required).

ghl_brand_board_create_voiceA

Create Brand Voice Create a brand voice for a location Endpoint: POST /brand-boards/locations/{locationId}/brand-voices (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/voices.write

Inputs: body (required), locationId (required).

ghl_brand_board_deleteA
DestructiveIdempotent

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Delete a Brand Board Deletes a Brand Board Endpoint: DELETE /brand-boards/{locationId}/{id} (Version header: 2021-07-28; source: brand-boards.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.write

Inputs: id (required), locationId (required).

ghl_brand_board_delete_design_kitA
DestructiveIdempotent

Delete Design Kit Delete a design kit by ID Endpoint: DELETE /brand-boards/locations/{locationId}/design-kits/{designKitId} (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.write

Inputs: locationId (required), designKitId (required).

ghl_brand_board_delete_voiceA
DestructiveIdempotent

Delete Brand Voice Delete a brand voice by ID Endpoint: DELETE /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/voices.write

Inputs: locationId (required), brandVoiceId (required).

ghl_brand_board_get_by_idA
Read-onlyIdempotent

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Brand Board Retrieves a specific Brand Board by its ID Endpoint: GET /brand-boards/{locationId}/{id} (Version header: 2021-07-28; source: brand-boards.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.readonly

Inputs: id (required), locationId (required).

ghl_brand_board_get_by_locationA
Read-onlyIdempotent

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Brand Boards Retrieves all Brand Boards for a specific location Endpoint: GET /brand-boards/{locationId} (Version header: 2021-07-28; source: brand-boards.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), limit, offset, search, +1 more.

ghl_brand_board_get_design_kitA
Read-onlyIdempotent

Get Design Kit Get a design kit by ID Endpoint: GET /brand-boards/locations/{locationId}/design-kits/{designKitId} (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.readonly

Inputs: locationId (required), designKitId (required).

ghl_brand_board_get_voiceA
Read-onlyIdempotent

Get Brand Voice Get a brand voice by ID Endpoint: GET /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/voices.readonly

Inputs: locationId (required), brandVoiceId (required).

ghl_brand_board_list_design_kitsA
Read-onlyIdempotent

List Design Kits Get list of design kits for a location Endpoint: GET /brand-boards/locations/{locationId}/design-kits (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), limit, offset, search, +1 more.

ghl_brand_board_list_voicesA
Read-onlyIdempotent

List Brand Voices Get list of brand voices for a location Endpoint: GET /brand-boards/locations/{locationId}/brand-voices (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/voices.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), limit, offset, search, +1 more.

ghl_brand_board_set_default_design_kitA

Set Default Design Kit Set a design kit as the default for a location. The previous default will be unset. Endpoint: POST /brand-boards/locations/{locationId}/design-kits/{designKitId}/default (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.write

Inputs: locationId (required), designKitId (required).

ghl_brand_board_set_default_voiceA

Set Default Brand Voice Set a brand voice as the default for a location. The previous default will be unset. Endpoint: POST /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}/default (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/voices.write

Inputs: locationId (required), brandVoiceId (required).

ghl_brand_board_updateA

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Update a Brand Board Updates an existing Brand Board Endpoint: PATCH /brand-boards/{locationId}/{id} (Version header: 2021-07-28; source: brand-boards.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.write

Inputs: id (required), body (required), locationId (required).

ghl_brand_board_update_design_kitB

Update Design Kit Update a design kit by ID Endpoint: PATCH /brand-boards/locations/{locationId}/design-kits/{designKitId} (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.write

Inputs: body (required), locationId (required), designKitId (required).

ghl_brand_board_update_voiceA

Update Brand Voice Update a brand voice by ID Endpoint: PATCH /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} (Version header: v3; source: v3/brand-boards-v3.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/voices.write

Inputs: body (required), locationId (required), brandVoiceId (required).

ghl_business_createA

Create Business Endpoint: POST /businesses/ (Version header: v3; source: v3/businesses-v3.json) OAuth scopes: businesses.write

Inputs: body (required).

ghl_business_deleteB
DestructiveIdempotent

Delete Business Endpoint: DELETE /businesses/{businessId} (Version header: v3; source: v3/businesses-v3.json) OAuth scopes: businesses.write

Inputs: businessId (required).

ghl_business_getA
Read-onlyIdempotent

Get Business Endpoint: GET /businesses/{businessId} (Version header: v3; source: v3/businesses-v3.json) OAuth scopes: businesses.readonly

Inputs: businessId (required).

ghl_business_get_businesses_by_locationB
Read-onlyIdempotent

Get Businesses by Location Endpoint: GET /businesses/ (Version header: v3; source: v3/businesses-v3.json) OAuth scopes: businesses.readonly Pagination params: limit, skip — pass them to page through full result sets.

Inputs: locationId (required), skip, limit.

ghl_business_updateC
Idempotent

Update Business Endpoint: PUT /businesses/{businessId} (Version header: v3; source: v3/businesses-v3.json) OAuth scopes: businesses.write

Inputs: body (required), businessId (required).

ghl_calendar_appointment_createB

Create appointment Endpoint: POST /calendars/events/appointments (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required).

ghl_calendar_appointment_getB
Read-onlyIdempotent

Get Appointment Get appointment by ID Endpoint: GET /calendars/events/appointments/{eventId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly

Inputs: eventId (required).

ghl_calendar_appointment_note_createC

Create Note Endpoint: POST /calendars/appointments/{appointmentId}/notes (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), appointmentId (required).

ghl_calendar_appointment_note_deleteB
DestructiveIdempotent

Delete Note Endpoint: DELETE /calendars/appointments/{appointmentId}/notes/{noteId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: noteId (required), appointmentId (required).

ghl_calendar_appointment_note_listA
Read-onlyIdempotent

Get Notes Get Appointment Notes Endpoint: GET /calendars/appointments/{appointmentId}/notes (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: limit (required), offset (required), appointmentId (required).

ghl_calendar_appointment_note_updateB
Idempotent

Update Note Endpoint: PUT /calendars/appointments/{appointmentId}/notes/{noteId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), noteId (required), appointmentId (required).

ghl_calendar_appointment_updateC
Idempotent

Update Appointment Update appointment Endpoint: PUT /calendars/events/appointments/{eventId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), eventId (required).

ghl_calendar_block_slot_createC

Create Block Slot Create block slot Endpoint: POST /calendars/events/block-slots (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required).

ghl_calendar_block_slot_updateB
Idempotent

Update Block Slot Update block slot by ID Endpoint: PUT /calendars/events/block-slots/{eventId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), eventId (required).

ghl_calendar_createB

Create Calendar Create calendar in a location. Endpoint: POST /calendars/ (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required).

ghl_calendar_deleteA
DestructiveIdempotent

Delete Calendar Delete calendar by ID Endpoint: DELETE /calendars/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: calendarId (required).

ghl_calendar_event_deleteA
DestructiveIdempotent

Deletes any calendar event by ID (appointment or block-slot). Use ghl_calendar_appointment_* or ghl_calendar_block_slot_* for type-specific create/get/update. Delete Event Delete event by ID Endpoint: DELETE /calendars/events/{eventId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), eventId (required).

ghl_calendar_event_listC
Read-onlyIdempotent

Get Calendar Events Endpoint: GET /calendars/events (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly

Inputs: endTime (required), startTime (required), locationId (required), userId, +2 more.

ghl_calendar_event_schedule_createA

Create event calendar availability schedule Create a new availability schedule specifically for an event calendar. The calendar ID is provided in the path, and schedule rules and timezone are provided in the request body. Endpoint: POST /calendars/schedules/event-calendar/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required), calendarId (required).

ghl_calendar_event_schedule_getB
Read-onlyIdempotent

Get event calendar availability schedule Retrieve the availability schedule for a specific event calendar. Returns the schedule associated with the calendar ID provided in the path. Endpoint: GET /calendars/schedules/event-calendar/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: calendarId (required).

ghl_calendar_event_schedule_updateA
Idempotent

Update event calendar availability schedule Update the availability schedule for a specific event calendar. Only provided fields will be updated. The calendar ID is provided in the path. Endpoint: PUT /calendars/schedules/event-calendar/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required), calendarId (required).

ghl_calendar_getA
Read-onlyIdempotent

Get Calendar Get calendar by ID Endpoint: GET /calendars/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: calendarId (required).

ghl_calendar_group_createA

Create Calendar Group Endpoint: POST /calendars/groups (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/groups.write

Inputs: body (required).

ghl_calendar_group_deleteC
DestructiveIdempotent

Delete Group Endpoint: DELETE /calendars/groups/{groupId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/groups.write

Inputs: groupId (required).

ghl_calendar_group_listA
Read-onlyIdempotent

Get Groups Get all calendar groups in a location. Endpoint: GET /calendars/groups (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/groups.readonly

Inputs: locationId (required).

ghl_calendar_group_updateB
Idempotent

Update Group Update Group by group ID Endpoint: PUT /calendars/groups/{groupId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/groups.write

Inputs: body (required), groupId (required).

ghl_calendar_group_update_statusA
Idempotent

Despite the underlying 'disable-group' operation name, the required body field isActive (boolean) toggles both directions — set isActive:true to re-enable the group. Disable Group Endpoint: PUT /calendars/groups/{groupId}/status (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/groups.write

Inputs: body (required), groupId (required).

ghl_calendar_group_validate_slugB

Validate group slug Validate if group slug is available or not. Endpoint: POST /calendars/groups/validate-slug (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/groups.write

Inputs: body (required).

ghl_calendar_listB
Read-onlyIdempotent

Get Calendars Get all calendars in a location. Endpoint: GET /calendars/ (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: locationId (required), groupId, showDrafted.

ghl_calendar_list_blocked_slotsB
Read-onlyIdempotent

startTime/endTime are epoch milliseconds passed as strings. Get Blocked Slots Endpoint: GET /calendars/blocked-slots (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly

Inputs: endTime (required), startTime (required), locationId (required), userId, +2 more.

ghl_calendar_list_free_slotsA
Read-onlyIdempotent

startDate/endDate are epoch milliseconds (a number, e.g. 1548898600000), NOT an ISO date string, despite the parameter name. Date range cannot exceed 31 days. Get Free Slots Get free slots for a calendar between a date range. Optionally a consumer can also request free slots in a particular timezone and also for a particular user. Endpoint: GET /calendars/{calendarId}/free-slots (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: endDate (required), startDate (required), calendarId (required), userId, +3 more.

ghl_calendar_notification_createA

Create notification Create Calendar notifications, either one or multiple. All notification settings must be for single calendar only Endpoint: POST /calendars/{calendarId}/notifications (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), calendarId (required).

ghl_calendar_notification_deleteA
DestructiveIdempotent

Delete Notification Delete notification Endpoint: DELETE /calendars/{calendarId}/notifications/{notificationId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: calendarId (required), notificationId (required).

ghl_calendar_notification_getA
Read-onlyIdempotent

Get notification Find Event notification by notificationId Endpoint: GET /calendars/{calendarId}/notifications/{notificationId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly

Inputs: calendarId (required), notificationId (required).

ghl_calendar_notification_listA
Read-onlyIdempotent

Get notifications Get calendar notifications based on query Endpoint: GET /calendars/{calendarId}/notifications (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly Pagination params: limit, skip — pass them to page through full result sets.

Inputs: calendarId (required), skip, limit, deleted, +1 more.

ghl_calendar_notification_updateB
Idempotent

Update notification Update Event notification by id Endpoint: PUT /calendars/{calendarId}/notifications/{notificationId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), calendarId (required), notificationId (required).

ghl_calendar_resource_createB

Uses the currently-documented (non-deprecated) Calendar Resources version, 2021-04-15. The v3-tagged variant of this operation in the v3 spec is marked deprecated (Services V1) with identical request/response fields — do not use Version: v3 for resource endpoints. Create Calendar Resource Create calendar resource by resource type (Services V1) Endpoint: POST /calendars/resources/{resourceType} (Version header: v3; source: v3/calendars-v3.json) Requires a Sub-Account (location) token. OAuth scopes: calendars/resources.write

Inputs: body (required), resourceType (required).

ghl_calendar_resource_deleteB
DestructiveIdempotent

Uses the currently-documented (non-deprecated) Calendar Resources version, 2021-04-15. The v3-tagged variant of this operation in the v3 spec is marked deprecated (Services V1) with identical request/response fields — do not use Version: v3 for resource endpoints. Delete Calendar Resource Delete calendar resource by ID (Services V1) Endpoint: DELETE /calendars/resources/{resourceType}/{id} (Version header: v3; source: v3/calendars-v3.json) Requires a Sub-Account (location) token. OAuth scopes: calendars/resources.write

Inputs: id (required), resourceType (required).

ghl_calendar_resource_getA
Read-onlyIdempotent

Uses the currently-documented (non-deprecated) Calendar Resources version, 2021-04-15. The v3-tagged variant of this operation in the v3 spec is marked deprecated (Services V1) with identical request/response fields — do not use Version: v3 for resource endpoints. Get Calendar Resource Get calendar resource by ID (Services V1) Endpoint: GET /calendars/resources/{resourceType}/{id} (Version header: v3; source: v3/calendars-v3.json) Requires a Sub-Account (location) token. OAuth scopes: calendars/resources.readonly

Inputs: id (required), resourceType (required).

ghl_calendar_resource_listA
Read-onlyIdempotent

Uses the currently-documented (non-deprecated) Calendar Resources version, 2021-04-15. The v3-tagged variant of this operation in the v3 spec is marked deprecated (Services V1) with identical request/response fields — do not use Version: v3 for resource endpoints. List Calendar Resources List calendar resources by resource type and location ID (Services V1) Endpoint: GET /calendars/resources/{resourceType} (Version header: v3; source: v3/calendars-v3.json) Requires a Sub-Account (location) token. OAuth scopes: calendars/resources.readonly Pagination params: limit, skip — pass them to page through full result sets.

Inputs: skip (required), limit (required), locationId (required), resourceType (required).

ghl_calendar_resource_updateA
Idempotent

Uses the currently-documented (non-deprecated) Calendar Resources version, 2021-04-15. The v3-tagged variant of this operation in the v3 spec is marked deprecated (Services V1) with identical request/response fields — do not use Version: v3 for resource endpoints. Update Calendar Resource Update calendar resource by ID (Services V1) Endpoint: PUT /calendars/resources/{resourceType}/{id} (Version header: v3; source: v3/calendars-v3.json) Requires a Sub-Account (location) token. OAuth scopes: calendars/resources.write

Inputs: id (required), body (required), resourceType (required).

ghl_calendar_schedule_assignB
Idempotent

Applies an existing user availability schedule to the given calendar. Apply user availability schedule to a calendar Associates a calendar with the given schedule by adding the calendarId to a schedule Endpoint: PUT /calendars/schedules/{id}/associations/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: id (required), calendarId (required).

ghl_calendar_schedule_createA

Create user availability schedule Create new schedule with specified rules, timezone, location, user and calendar associations. Endpoint: POST /calendars/schedules (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required).

ghl_calendar_schedule_deleteA
DestructiveIdempotent

Delete user availability schedule Permanently remove a schedule and all its associated rules. This action cannot be undone. Endpoint: DELETE /calendars/schedules/{id} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: id (required).

ghl_calendar_schedule_getA
Read-onlyIdempotent

Get user availability schedule Retrieve a specific schedule by its unique identifier. Returns detailed information including rules, timezone, and associated calendars/users. Endpoint: GET /calendars/schedules/{id} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: id (required).

ghl_calendar_schedule_listA
Read-onlyIdempotent

List user availability schedule Retrieve user availability schedules based on various filters including location, calendar, and user. Supports pagination. Endpoint: GET /calendars/schedules/search (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: userId (required), locationId (required), skip, limit, +1 more.

ghl_calendar_schedule_unassignA
DestructiveIdempotent

Removes a user availability schedule association from the given calendar. Remove user availability schedule from a calendar Removes the association between a team calendar and the given schedule by removing the calendarId from the schedule Endpoint: DELETE /calendars/schedules/{id}/associations/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: id (required), calendarId (required).

ghl_calendar_schedule_updateA
Idempotent

Update user availability schedule Modify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated. Endpoint: PUT /calendars/schedules/{id} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: id (required), body (required).

ghl_calendar_service_booking_createB

Create Service Booking Create a new service booking Endpoint: POST /calendars/services/bookings (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), overrideAvailability, skipSchedulingNotice.

ghl_calendar_service_booking_deleteA
DestructiveIdempotent

Delete Service Booking Delete a service booking by ID Endpoint: DELETE /calendars/services/bookings/{bookingId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: bookingId (required).

ghl_calendar_service_booking_getB
Read-onlyIdempotent

Get Service Booking by ID Get a specific service booking by ID Endpoint: GET /calendars/services/bookings/{bookingId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly

Inputs: bookingId (required).

ghl_calendar_service_booking_listA
Read-onlyIdempotent

startTime/endTime are epoch milliseconds passed as strings. No limit/offset — results are bounded by the required date range. Get Service Bookings Retrieve service bookings for a location within a given date range, with an optional service location filter. Endpoint: GET /calendars/services/bookings (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly

Inputs: endTime (required), startTime (required), locationId (required), timezone, +1 more.

ghl_calendar_service_booking_updateB
Idempotent

Update Service Booking Update an existing service booking Endpoint: PUT /calendars/services/bookings/{bookingId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.write

Inputs: body (required), bookingId (required), overrideAvailability, skipSchedulingNotice.

ghl_calendar_service_createA

Create Service Create new service in a location. Endpoint: POST /calendars/services/catalog (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required).

ghl_calendar_service_deleteB
DestructiveIdempotent

Delete Service Delete service by ID. Endpoint: DELETE /calendars/services/catalog/{serviceId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: serviceId (required).

ghl_calendar_service_getA
Read-onlyIdempotent

Get Service by ID Get service by ID. Endpoint: GET /calendars/services/catalog/{serviceId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: serviceId (required).

ghl_calendar_service_listB
Read-onlyIdempotent

Get Services Get all services in a location. Endpoint: GET /calendars/services/catalog (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: locationId (required), isPrivate, serviceCategoryId.

ghl_calendar_service_location_createB

Create Service Location Create a new service location Endpoint: POST /calendars/services/locations (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required).

ghl_calendar_service_location_deleteA
DestructiveIdempotent

Delete Service Location Delete a service location by ID Endpoint: DELETE /calendars/services/locations/{serviceLocationId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: serviceLocationId (required).

ghl_calendar_service_location_getB
Read-onlyIdempotent

Get Service Location by ID Get service location by ID Endpoint: GET /calendars/services/locations/{serviceLocationId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: serviceLocationId (required).

ghl_calendar_service_location_listC
Read-onlyIdempotent

Get Service Locations Get all service locations Endpoint: GET /calendars/services/locations (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.readonly

Inputs: locationId (required).

ghl_calendar_service_location_updateA
Idempotent

Update Service Location Update an existing service location Endpoint: PUT /calendars/services/locations/{serviceLocationId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required), serviceLocationId (required).

ghl_calendar_service_updateB
Idempotent

Update Service Update service by ID. Endpoint: PUT /calendars/services/catalog/{serviceId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required), serviceId (required).

ghl_calendar_updateB
Idempotent

Update Calendar Update calendar by ID. Endpoint: PUT /calendars/{calendarId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars.write

Inputs: body (required), calendarId (required).

ghl_campaign_listC
Read-onlyIdempotent

Get Campaigns Endpoint: GET /campaigns/ (Version header: v3; source: v3/campaigns-v3.json) OAuth scopes: campaigns.readonly

Inputs: locationId (required), status.

ghl_chat_widget_cloneA

Clone a Chat Widget Clones an existing chat widget into a new widget Endpoint: POST /chat-widget/clone (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.write

Inputs: body (required).

ghl_chat_widget_createA

Create a new chat widget Creates a new chat widget for a specific location Endpoint: POST /chat-widget/ (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.write

Inputs: body (required).

ghl_chat_widget_deleteA
DestructiveIdempotent

Delete a Chat Widget Deletes a chat widget by ID Endpoint: DELETE /chat-widget/{locationId}/{id} (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.write

Inputs: id (required), locationId (required).

ghl_chat_widget_getA
Read-onlyIdempotent

Get Chat Widget by ID Returns the full chat widget configuration for the given location and widget ID Endpoint: GET /chat-widget/data/{locationId}/{id} (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.readonly

Inputs: id (required), locationId (required).

ghl_chat_widget_listA
Read-onlyIdempotent

List Chat Widgets Retrieves a list of chat widgets for a specific location Endpoint: GET /chat-widget/list (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.readonly Pagination params: offset, limit — pass them to page through full result sets.

Inputs: limit (required), offset (required), locationId (required), chatType, +4 more.

ghl_chat_widget_patchA

Patch Chat Widget Applies a partial update to an existing chat widget Endpoint: PATCH /chat-widget/data/{locationId}/{id} (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.write

Inputs: id (required), body (required), locationId (required).

ghl_chat_widget_updateA
Idempotent

Update Chat Widget Replaces an existing chat widget with the provided configuration Endpoint: PUT /chat-widget/data/{locationId}/{id} (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.write

Inputs: id (required), body (required), locationId (required).

ghl_clientportal_answer_agent_run_questions_batchA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Answer every question of one form in a single write. Records up to 12 answers in one run write and resumes the run once, so a multi-question form does not resume the planner per answer. Same per-answer rules as POST …/answers (records review approval by approve:<reviewId> only, decline:<reviewId> declines, anything else is a change request); attachmentIds are ignored here. Project-scoped (404 for another project's run); locationId comes from the session, never from the body.

Idempotency: an answer whose capId and correlationId match the recorded one is skipped; when every answer is such a duplicate nothing is written and the run is not resumed again (still 202). Endpoint: POST /ai-builder-api/projects/{projectId}/runs/{runId}/answers/batch (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), runId (required), projectId (required).

ghl_clientportal_apply_project_changeA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Apply a signed plan once. Idempotent on planId: a second (or concurrent) apply of the same plan returns the first apply's result without writing again (queued while the first is still running). Apply re-checks the stored change against what exists now; when it moved, the answer is 409 change_plan_stale with a fix (plan again). An expired plan is 409 too. A partial result stays open: applying the same plan again finishes only what is left. Another location's or project's plan is 404. Endpoint: POST /ai-builder-api/projects/{projectId}/changes/apply (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required).

ghl_clientportal_cli_get_project_contextA
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Read an app's stack and open its sandbox for editing. Returns the app's stack, which decides how its code is written, and its kernel bundle, and opens the app's sandbox: read and edit it once sandbox.status is ready. A react_native_app_kernel_v1 app is a phone app: its screens are files under apps/mobile/app-extensions/, registered with POST .../sandbox/extension-routes. Every other stack is a web portal. Endpoint: GET /ai-builder-api/cli/projects/{projectId}/context (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: projectId (required).

ghl_clientportal_cli_sandbox_checkpointA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Save the app's sandbox files as the point it restarts from. Saves the sandbox's files so a sandbox that restarts comes back with them. Call it after a set of POST .../sandbox/edit calls and before starting the run that builds them: a sandbox that restarts in between otherwise comes back with the files as they were at the last save. Endpoint: POST /ai-builder-api/cli/projects/{projectId}/sandbox/checkpoint (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: projectId (required), body.

ghl_clientportal_cli_sandbox_editA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Write or delete one file in the app's sandbox. Writes or deletes one file in the app's sandbox. After a set of edits, save them with POST .../sandbox/checkpoint, then start a run with externalAgent: true to check, build and deploy them. A React Native app (react_native_app_kernel_v1) writes only under apps/mobile/app-extensions/ and apps/mobile/application-assets/; its routes.ts is generated, so register its screens with POST .../sandbox/extension-routes instead of writing that file. Endpoint: POST /ai-builder-api/cli/projects/{projectId}/sandbox/edit (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required).

ghl_clientportal_cli_sandbox_register_extension_routeA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Register, rename or remove a React Native app's screens. Changes the screen list of a React Native app (react_native_app_kernel_v1) once its screen files are written with POST .../sandbox/edit: app-extensions/routes.ts is generated from these changes, never written as text. Send several changes as one batch: all of them apply or none does, and a resent batch that is already in effect changes nothing (a repeated single add is refused as duplicate_id). The run started next with externalAgent: true checks the screens, saves them as a mobile revision and deploys the preview. Endpoint: POST /ai-builder-api/cli/projects/{projectId}/sandbox/extension-routes (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required).

ghl_clientportal_cli_sandbox_viewA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Read a file in the app's sandbox, or list a folder. Reads one file of the app's code, or lists a folder's files and subfolders, so an agent sees what is there before it edits. A folder path always lists. The kernel's own files are readable; the writable boundary applies only to POST .../sandbox/edit. Endpoint: POST /ai-builder-api/cli/projects/{projectId}/sandbox/view (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: body (required), projectId (required).

ghl_clientportal_create_mobile_experience_preview_tokenB

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Create a preview link token for a phone app. A short-lived token that makes the app's preview show this app. Open sandbox.devUrl from GET .../cli/projects/{projectId}/context with #previewToken=<token> appended; without it the preview shows the stock app. Endpoint: POST /ai-builder-api/projects/{projectId}/app-config/mobile-preview-token (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required), body.

ghl_clientportal_create_projectA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Create a project. Creates an app in the sub-account. Then start its first build with POST .../agent-runs; a sub-account token sends externalAgent: true because its own agent writes the code. Endpoint: POST /ai-builder-api/projects (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), Idempotency-Key.

ghl_clientportal_get_agent_runB
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Get the current state of a run (poll-friendly). Strictly tenant- and project-scoped. A run that exists under a different projectId (or under a different tenant entirely) returns 404 not_found — never 403, never the run record. This matches OWASP API1:2023 Broken Object Level Authorization guidance: same shape for "doesn't exist" and "not yours". Endpoint: GET /ai-builder-api/projects/{projectId}/runs/{runId} (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: runId (required), projectId (required).

ghl_clientportal_get_app_customizationB
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Get which revision of an app is newest, applied and published. A phone app saves a revision at the end of each run. Publish it with POST .../app-config/publish once appliedRevision equals revision and status is ready. Endpoint: GET /ai-builder-api/projects/{projectId}/app-config (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required).

ghl_clientportal_get_mobile_apk_buildB
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Get an APK build's status and download link. Read it again until status is finished, when artifactUrl is a short-lived download link, or failed, when error says why. Endpoint: GET /ai-builder-api/projects/{projectId}/app-config/apk-builds/{apkBuildId} (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required), apkBuildId (required).

ghl_clientportal_get_projectC
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Get a project by id. Returns one app: its status, publication state, preview and production URLs, and its latest run. Endpoint: GET /ai-builder-api/projects/{projectId} (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required).

ghl_clientportal_get_project_change_schemaB
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. JSON Schema and an example for each change kind. Static per server release: what change must look like for each kind POST /changes/plan accepts, as JSON Schema (draft 2020-12, input shape) with one valid example. Endpoint: GET /ai-builder-api/projects/{projectId}/changes/schema (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required), kind.

ghl_clientportal_get_project_publishabilityA
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Check whether an app can be published now, and which build would go live. Computed by the same resolver as promote-to-production. Without sourceRunId: publishable iff some ready run of this project (caller's location, main lineage) has a sealed build; the newest one goes live with the newest config-only revision made on its lineage. With sourceRunId (the reviewed preview): publishes what that preview shows — its own sealed build, or for a ready run that built nothing, the sealed build it descends from with config-only edits on that lineage; a run that failed or has not finished is reviewed_preview_not_publishable. Send the returned sourceRunId on promote-to-production. Tenant scope comes from the session only. Endpoint: GET /ai-builder-api/projects/{projectId}/publishability (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required), sourceRunId.

ghl_clientportal_get_project_publish_jobB
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Read a publish job's progress. Reports a publish job's progress. Poll it every few seconds until status is succeeded, when publishedUrl is the live site, or failed, when error says why. Endpoint: GET /ai-builder-api/projects/{projectId}/infra/publish-jobs/{publishJobId} (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required), publishJobId (required).

ghl_clientportal_list_agent_runs_for_projectA
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. List an app's runs, newest first. Returns the project's runs ordered newest-first by createdAt. The FE calls this when a user reopens a project to rebuild the chat history; pair with listAgentRunEvents per run to replay each prompt's full event log.

Production-backed by Mongo (ai_builder_runs_records). Persists across pod restarts and is shared across pods. Endpoint: GET /ai-builder-api/projects/{projectId}/runs (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: projectId (required), limit.

ghl_clientportal_list_mobile_customization_revisionsC
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. List a phone app's saved revisions. Up to 50, newest first, marking the current one and the one members get. Return to one with POST .../app-config/revisions/{revision}/restore. Endpoint: GET /ai-builder-api/projects/{projectId}/app-config/revisions (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required).

ghl_clientportal_list_project_custom_domainsB
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. List the custom domains attached to a project. Lists the app's custom domains with their setup status and the DNS records to add. A domain is attached with changes kind domain; once it is active it serves the live site. Endpoint: GET /ai-builder-api/projects/{projectId}/custom-domains (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: projectId (required).

ghl_clientportal_list_projectsB
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. List projects in the caller's location. Lists the ClientPortal apps in the sub-account, most recently active first. A sub-account token sees every app by default; view=mine limits the list to apps the caller created. Endpoint: GET /ai-builder-api/projects (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly Pagination params: limit, cursor — pass them to page through full result sets.

Inputs: view, limit, cursor, status.

ghl_clientportal_list_templatesB
Read-onlyIdempotent

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. List the app templates a project can be created from. The template catalog powers the template picker on the landing page: the starters, then the vertical templates (ready-made vibe apps that the Jenkins vertical-templates-release publishes). Each entry has a stable id, a category, a human-readable name + summary, a version, and the stackTemplate a project from it is created on. A vertical template also names the CP Elements products it uses, and its card picture when it has one (previewUrl). Pass the chosen id as templateId and its stackTemplate on createProject. Endpoint: GET /ai-builder-api/catalog/templates (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.readonly

Inputs: no named parameters.

ghl_clientportal_plan_project_changeA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Check a change of one kind and sign a plan for it, without writing anything. The caller's AI writes a change of one kind; the server validates it against that kind's schema and against what exists now (CRM, modules, saved customization) and answers what applying it would do. Nothing is written and no model is called. planId is a signed token over {projectId, locationId, kind, changeHash} that expires at expiresAt; it is null when ok is false. The location is the session's, never the body's. Kinds: records, modules, appearance, mobile, assets, domain; any other kind is 400 unsupported_change_kind naming the supported ones. assets plans also return upload: PUT the image bytes to upload.url with upload.headers, then apply (apply is 409 customizer_image_not_uploaded until they land, and the plan stays open). domain apply returns the DNS records to add in result.dnsRecords; GET /custom-domains reports when it is active. Endpoint: POST /ai-builder-api/projects/{projectId}/changes/plan (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required).

ghl_clientportal_promote_project_to_productionA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Publish an app to its live site. Publishes the app to its live site: its managed address, and every custom domain attached to it (changes kind domain) once that domain is active. A domain that becomes active later joins the live site without another publish. Check GET .../publishability first and send the sourceRunId it returns, so the build the creator approved is the one that goes live. Returns a publish job: poll GET .../infra/publish-jobs/{publishJobId} until status is succeeded (publishedUrl is the live site) or failed (error says why). Send the same idempotencyKey to retry safely. Endpoint: POST /ai-builder-api/projects/{projectId}/infra/promote-to-production (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required).

ghl_clientportal_publish_app_customizationA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Publish a saved revision of an app to its members. For a phone app send platform: mobile and the revision from GET .../app-config: installed apps get it over the air. Screens your agent wrote reach members only in a new APK (POST .../app-config/apk-builds). web, the default, is for ClientPortal configuration apps; a coded web app publishes with POST .../infra/promote-to-production. Endpoint: POST /ai-builder-api/projects/{projectId}/app-config/publish (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required).

ghl_clientportal_request_mobile_apk_buildA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Build a signed Android APK of a published phone app revision. Idempotent per Idempotency-Key. For a project whose current revision carries generated screens, the build is instead identified by the revision and the generated sources it carries (sha256(locationId:projectId:revision:sourcesSha)): repeating the request for the same revision and sources returns the same build whatever the key, and a failed one is queued again. Such a build is made from the React Native kernel commit the screens were generated against, and must be requested for the current revision. Generated screens reach members only through a new APK; they are never delivered over the air. At most one build may be active per project; sibling projects in the same location may build in parallel. Deleting a project while its build is still queued or building fails that build. A project compiles one signed APK for now: after a successful build the binary is final. A project without generated screens keeps reaching installed apps by publishing a revision; a project with generated screens cannot build another APK yet. Failed builds do not consume the allowance. Endpoint: POST /ai-builder-api/projects/{projectId}/app-config/apk-builds (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required), Idempotency-Key (required).

ghl_clientportal_restore_mobile_customization_revisionA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Return a phone app to an earlier revision. Saves a copy of the earlier revision, screens included, as the newest one. Members get it once you publish it with POST .../app-config/publish. Endpoint: POST /ai-builder-api/projects/{projectId}/app-config/revisions/{revision}/restore (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), revision (required), projectId (required), Idempotency-Key (required).

ghl_clientportal_submit_agent_runA

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Submit a prompt; the agent runs in the background. Returns runId immediately. A sub-account token builds with its own agent: it writes the code with POST .../sandbox/edit (and registers a React Native app's screens with POST .../sandbox/extension-routes), saves the files with POST .../sandbox/checkpoint, then starts the run with externalAgent: true, which checks, builds and deploys them. Poll GET .../runs/{runId}: problems a passing build still has are in checkProblems.

The builder's own agent executes asynchronously: attempt workspace restore from project's prior run → materialise scaffold (only if no prior workspace) → loop tool calls → preflight pnpm build → flush workspace to GCS → deploy via Cloud Build → managed runtime revision replace → mark ready with a preview URL.

Per-project runtime services receive a stable public app hostname so the iframe URL works without platform-session auth.

Idempotency: callers SHOULD send an Idempotency-Key header on every retry. The server stores (locationId, projectId, key) → runId for 24 h. Same key + same body → the original runId is replayed. Same key + different body → 409 idempotency_conflict. Modeled after standard idempotent POST contracts; safe for browser retries, network blips, and double-click submits.

Attachment scope: when attachmentIds are present, each id is verified against the caller's tenant + project. Cross-project or cross-tenant reuse is rejected with 403 attachment_not_owned. Endpoint: POST /ai-builder-api/projects/{projectId}/runs (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required), Idempotency-Key, X-Correlation-Id.

ghl_clientportal_update_projectB

CLIENT PORTAL AI BUILDER API (/ai-builder-api) — side-effecting: opens/edits sandboxes and starts builds. Edit a sandbox only once sandbox.status is ready; checkpoint after edits and before starting the run that builds them; 409 means a cloud build owns the sandbox or it is not running. Rename an app, archive it, or pin it to the top of the app list. Renames the app, archives it or brings it back, or pins it to the top of the app list. Send only the fields to change. Endpoint: PATCH /ai-builder-api/projects/{projectId} (Version header: v3; source: v3/clientportal-ai-v3.json) OAuth scopes: clientportal-ai.write

Inputs: body (required), projectId (required).

ghl_company_getA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Get Company Get Comapny Endpoint: GET /companies/{companyId} (Version header: v3; source: v3/companies-v3.json) Requires an Agency (company-level) token. OAuth scopes: companies.readonly

Inputs: companyId (required).

ghl_contact_add_followersB

Add Followers Endpoint: POST /contacts/{contactId}/followers (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required).

ghl_contact_add_remove_from_businessC

Add/Remove Contacts From Business Add/Remove Contacts From Business . Passing a null businessId will remove the businessId from the contacts Endpoint: POST /contacts/bulk/business (Version header: v3; source: v3/contacts-v3.json)

Inputs: body (required).

ghl_contact_add_tagsC

Add Tags Endpoint: POST /contacts/{contactId}/tags (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required).

ghl_contact_add_to_campaignA

Adds a contact to one specific campaign. Empty request body (path params only). Add Contact to Campaign Add contact to Campaign Endpoint: POST /contacts/{contactId}/campaigns/{campaignId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required), campaignId (required).

ghl_contact_add_to_workflowB

Add Contact to Workflow Endpoint: POST /contacts/{contactId}/workflow/{workflowId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required), workflowId (required).

ghl_contact_bulk_update_tagsA

Bulk add/remove tags across a list of contacts (path param type selects add|remove semantics per the API). Renamed from the auto-generated 'ghl_contact_create_association' — that name was simply wrong; this operation has nothing to do with the associations domain (custom relationships between object types). Body requires contacts, tags, locationId; removeAllTags is an optional bulk-remove-all flag. Update Contacts Tags Allows you to update tags to multiple contacts at once, you can add or remove tags from the contacts Endpoint: POST /contacts/bulk/tags/update/{type} (Version header: v3; source: v3/contacts-v3.json)

Inputs: body (required), type (required).

ghl_contact_createB

Create Contact Create a new contact Endpoint: POST /contacts/ (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required).

ghl_contact_create_noteB

Create Note Endpoint: POST /contacts/{contactId}/notes (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required).

ghl_contact_create_taskA

REGRESSION-VERIFIED: assignedTo is present in CreateTaskParams. The old connector's create_task always 422'd — per the spec (v3/contacts-v3.json CreateTaskParams.required), title, dueDate, and completed are ALL required on create (not just title), and dueDate must be ISO 8601 (e.g. 2020-10-25T11:00:00Z). Passing completed:false is required even though it reads oddly for a brand-new task — that's what the spec mandates. Create Task Endpoint: POST /contacts/{contactId}/tasks (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required).

ghl_contact_deleteB
DestructiveIdempotent

Delete Contact Endpoint: DELETE /contacts/{contactId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: contactId (required).

ghl_contact_delete_from_workflowB
DestructiveIdempotent

Delete Contact from Workflow Endpoint: DELETE /contacts/{contactId}/workflow/{workflowId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required), workflowId (required).

ghl_contact_delete_noteB
DestructiveIdempotent

Delete Note Endpoint: DELETE /contacts/{contactId}/notes/{id} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: id (required), contactId (required).

ghl_contact_delete_taskC
DestructiveIdempotent

Delete Task Endpoint: DELETE /contacts/{contactId}/tasks/{taskId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: taskId (required), contactId (required).

ghl_contact_get_all_notesB
Read-onlyIdempotent

Get All Notes Endpoint: GET /contacts/{contactId}/notes (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly

Inputs: contactId (required).

ghl_contact_get_all_tasksB
Read-onlyIdempotent

Get all Tasks Endpoint: GET /contacts/{contactId}/tasks (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly

Inputs: contactId (required).

ghl_contact_get_appointmentsB
Read-onlyIdempotent

Renamed from the auto-generated 'ghl_contact_get_appointments_for' (truncated trailing word). Get Appointments for Contact Endpoint: GET /contacts/{contactId}/appointments (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly

Inputs: contactId (required).

ghl_contact_get_by_business_idA
Read-onlyIdempotent

Get Contacts By BusinessId Endpoint: GET /contacts/business/{businessId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly Pagination params: limit, skip, startAfter — pass them to page through full result sets.

Inputs: businessId (required), locationId (required), skip, limit, +2 more.

ghl_contact_get_by_idA
Read-onlyIdempotent

Fetches a single contact by ID. Distinct from ghl_contact_list (GET /contacts/, deprecated list) and ghl_contact_search_advanced (POST /contacts/search, filtered search) — renamed from the auto-generated 'ghl_contact_get_get2' (a collision-resolution artifact) for clarity per the audit brief's explicit ambiguity callout. Get Contact Retrieves a contact by its unique identifier. Endpoint: GET /contacts/{contactId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly

Inputs: contactId (required).

ghl_contact_get_duplicateA
Read-onlyIdempotent

Neither number nor email is marked required by the spec, but at least one must be supplied for the lookup to return anything meaningful — this is a business-logic constraint the OpenAPI doesn't encode, not a bug in extraction. Both params must be URL-encoded (see each param's spec description/example). Get Duplicate Contact Get Duplicate Contact.If Allow Duplicate Contact is disabled under Settings, the global unique identifier will be used for searching the contact. If the setting is enabled, first priority for search is email and the second priority will be phone. Endpoint: GET /contacts/search/duplicate (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly

Inputs: locationId (required), email, number.

ghl_contact_get_noteB
Read-onlyIdempotent

Get Note Endpoint: GET /contacts/{contactId}/notes/{id} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly

Inputs: id (required), contactId (required).

ghl_contact_get_taskA
Read-onlyIdempotent

Get Task Endpoint: GET /contacts/{contactId}/tasks/{taskId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly

Inputs: taskId (required), contactId (required).

ghl_contact_listA
Read-onlyIdempotent

Deprecated by GoHighLevel — prefer ghl_contact_search_advanced (POST /contacts/search) for new integrations. Kept registered for legacy callers. Returns a simple paginated list filtered by an optional free-text query, not the advanced filter/sort search. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Contacts Get Contacts

Note: This API endpoint is deprecated. Please use the Search Contacts endpoint instead. Endpoint: GET /contacts/ (Version header: 2021-07-28; source: contacts.json) OAuth scopes: contacts.readonly Pagination params: startAfterId, startAfter, limit — pass them to page through full result sets.

Inputs: locationId (required), limit, query, startAfter, +1 more.

ghl_contact_lookupA
Read-onlyIdempotent

Lookup Contact By Email Or Phone Look up contacts matching an exact email or phone, scoped to a location, up to limit contacts (max 20) per page. Also matches against a contact's additional emails and additional phone numbers. Exactly one of email or phone must be provided. Paginate with nextCursor. Returns an empty contacts array if no contact matches. OAuth channel only. Endpoint: GET /contacts/lookup (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), email, limit, phone, +1 more.

ghl_contact_remove_followersB
DestructiveIdempotent

Remove Followers Endpoint: DELETE /contacts/{contactId}/followers (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required).

ghl_contact_remove_from_all_campaignsA
DestructiveIdempotent

v3-preferred variant of removing a contact from every campaign (kebab-case path, v3/contacts-v3.json). Renamed from the auto-generated 'ghl_contact_remove_from_every_campaign_delete2' (an ugly auto-suffix produced because it collided with the legacy op's derived name). Remove Contact From Every Campaign Removes the contact from every campaign it is enrolled in. Endpoint: DELETE /contacts/{contactId}/campaigns/remove-all (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: contactId (required).

ghl_contact_remove_from_all_campaigns_legacyA
DestructiveIdempotent

Legacy path variant (contacts.json, 2021-07-28) of removing a contact from every campaign. Functionally equivalent to ghl_contact_remove_from_all_campaigns (v3, DELETE /contacts/{contactId}/campaigns/remove-all) — prefer the v3 tool for new integrations. Renamed from the auto-generated name to disambiguate the two distinct-but-similar endpoints (was colliding with the v3 op's derived name, which got an ugly auto '_delete2' suffix). [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Remove Contact From Every Campaign Endpoint: DELETE /contacts/{contactId}/campaigns/removeAll (Version header: 2021-07-28; source: contacts.json) OAuth scopes: contacts.write

Inputs: contactId (required).

ghl_contact_remove_from_campaignB
DestructiveIdempotent

Remove Contact From Campaign Endpoint: DELETE /contacts/{contactId}/campaigns/{campaignId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: contactId (required), campaignId (required).

ghl_contact_remove_tagsB
DestructiveIdempotent

Remove Tags Endpoint: DELETE /contacts/{contactId}/tags (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required).

ghl_contact_search_advancedA
Read-onlyIdempotent

SPEC GAP: the official OpenAPI's SearchBodyV2DTO is an empty object schema — GoHighLevel's spec only points to an external ClickUp doc (linked in the op's externalDocs) for the real filter/sort/pageLimit/searchAfter/query body shape, which is not available in this docs corpus. Verified this is a genuine spec gap (not an extraction bug) against both the legacy (contacts.json) and v3 (v3/contacts-v3.json) copies of this endpoint, and via ghl_docs_context — both show the identical empty schema. The generated tool's body property will still accept arbitrary JSON (no additionalProperties:false is applied inside body sub-schemas), so callers who know the real field names from GHL's docs can pass them; there's just no schema-level validation or autocomplete for this one operation. Search Contacts Search contacts based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-158396/6e629989abe7fad Endpoint: POST /contacts/search (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.readonly

Inputs: body (required).

ghl_contact_updateA
Idempotent

REGRESSION-VERIFIED: body schema (UpdateContactDtoV3, v3/contacts-v3.json) includes assignedTo, customFields, tags, dnd, dndSettings, inboundDndSettings, address1, city, state, postalCode, country, dateOfBirth, source, website, timezone — all confirmed present against the raw spec, matching what the old connector was missing. tags on this endpoint overwrites the full tag list; use ghl_contact_add_tags/ghl_contact_remove_tags for incremental changes. Update Contact Update a contact using contactId

⚠️ When updating additional emails/phones, always include the current primary email/phone in the same request. Otherwise, the existing primary value may be lost. Endpoint: PUT /contacts/{contactId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), contactId (required).

ghl_contact_update_noteB
Idempotent

Update Note Endpoint: PUT /contacts/{contactId}/notes/{id} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: id (required), body (required), contactId (required).

ghl_contact_update_taskA
Idempotent

REGRESSION-VERIFIED: assignedTo is present in UpdateTaskBody. Unlike create, no fields are marked required on update — all of title/body/dueDate/completed/assignedTo are optional partial updates. Update Task Endpoint: PUT /contacts/{contactId}/tasks/{taskId} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), taskId (required), contactId (required).

ghl_contact_update_task_completedB
Idempotent

Update Task Completed Endpoint: PUT /contacts/{contactId}/tasks/{taskId}/completed (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required), taskId (required), contactId (required).

ghl_contact_upsertA

Requires locationId. Same field set as ghl_contact_create; use createNewIfDuplicateAllowed to control dedup behavior. Upsert Contact The Upsert API will adhere to the configuration defined under the "Allow Duplicate Contact" setting at the Location level. If the setting is configured to check both Email and Phone, the API will attempt to identify an existing contact based on the priority sequence specified in the setting, and will create or update the contact accordingly.If two separate contacts already exist—one with the same email and another with the same phone—and an upsert request includes both the email and phone, the API will update the contact that matches the first field in the configured sequence, and ignore the second field to prevent duplication. Endpoint: POST /contacts/upsert (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.write

Inputs: body (required).

ghl_conversation_add_inbound_messageA

Add an inbound message Post the necessary fields for the API to add a new inbound message. Note: Either conversationId or contactId is required Endpoint: POST /conversations/messages/inbound (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: body (required).

ghl_conversation_add_message_attachmentsA
Idempotent

Replaces/adds attachments (URLs) on an existing message — separate from POST /conversations/messages/upload, which is the file-binary upload step that produces those URLs. Add message attachments Set attachments on an existing message (replaces existing). Maximum 5 URLs. Supported for Custom Call message type. Endpoint: PUT /conversations/messages/{messageId}/attachments (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: body (required), messageId (required).

ghl_conversation_add_outbound_messageB

Add an external outbound call Post the necessary fields for the API to add a new outbound call. Endpoint: POST /conversations/messages/outbound (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: body (required).

ghl_conversation_ai_create_actionA

Attach Action to Agent Creates and attach a new action for an AI agent. Actions define specific tasks or behaviors that the agent can perform, such as booking appointments, sending follow-ups, collecting information, or making an external API call via the customApi ("API Call") type. For customApi, put the config in details (details.apiConfig is required) and a per-agent limit (up to 5) applies. Endpoint: POST /conversation-ai/agents/{agentId}/actions (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: body (required), agentId (required).

ghl_conversation_ai_create_agentB

Create an Agent Creates a new AI agent for the location. The agent will be created with the specified configuration including name, role, actions, and behavior settings. Endpoint: POST /conversation-ai/agents (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: body (required).

ghl_conversation_ai_create_agent_working_hoursA

Create Agent Working Hours Creates the working-hours configuration for an AI agent. Returns 409 when one already exists — use the update endpoint to replace it. Endpoint: POST /conversation-ai/agents/{agentId}/working-hours (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: body (required), agentId (required).

ghl_conversation_ai_delete_actionA
DestructiveIdempotent

Remove Action from Agent Permanently deletes an action. This will remove the action from all associated agents and cannot be undone. Applies to both classic and customApi ("API Call") actions. Endpoint: DELETE /conversation-ai/agents/{agentId}/actions/{actionId} (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: agentId (required), actionId (required).

ghl_conversation_ai_delete_agentA
DestructiveIdempotent

Delete Agent Deletes an AI agent permanently. This action cannot be undone. All associated configurations and conversation history will be removed. Endpoint: DELETE /conversation-ai/agents/{agentId} (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: agentId (required).

ghl_conversation_ai_delete_agent_working_hoursA
DestructiveIdempotent

Delete Agent Working Hours Deletes the working-hours configuration for an AI agent. The agent then replies at any time. Succeeds with deleted=false when there was nothing to delete. Endpoint: DELETE /conversation-ai/agents/{agentId}/working-hours (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: agentId (required).

ghl_conversation_ai_get_action_by_idA
Read-onlyIdempotent

Get Action by ID Retrieves detailed information about a specific action using its unique identifier. Returns the action configuration, associated agents, and performance metrics. Supports both classic actions and the customApi ("API Call") type. Endpoint: GET /conversation-ai/agents/{agentId}/actions/{actionId} (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.readonly

Inputs: agentId (required), actionId (required).

ghl_conversation_ai_get_agentA
Read-onlyIdempotent

Get Agent Retrieves a specific AI agent by its ID. Returns the complete agent configuration including name, status, actions, and settings. Endpoint: GET /conversation-ai/agents/{agentId} (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.readonly

Inputs: agentId (required).

ghl_conversation_ai_get_agent_actionsA
Read-onlyIdempotent

List Actions for an Agent List for actions for an agent, including any customApi ("API Call") actions. Endpoint: GET /conversation-ai/agents/{agentId}/actions (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.readonly

Inputs: agentId (required).

ghl_conversation_ai_get_agent_working_hoursA
Read-onlyIdempotent

Get Agent Working Hours Retrieves the working-hours configuration for an AI agent: the weekly schedule, the channels it applies to, the timezone mode, and the off-hours auto-reply and follow-up settings. Endpoint: GET /conversation-ai/agents/{agentId}/working-hours (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.readonly

Inputs: agentId (required).

ghl_conversation_ai_get_generationA
Read-onlyIdempotent

Get the generation details Retrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks, and Rich Text chunks. Endpoint: GET /conversation-ai/generations (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.readonly

Inputs: source (required), messageId (required).

ghl_conversation_ai_list_actionsA
Read-onlyIdempotent

[DEPRECATED per official docs — prefer the documented replacement if one exists.] List Actions for an Agent Deprecated — use GET /conversation-ai/agents/{agentId}/actions instead. List for actions for an agent, including any customApi ("API Call") actions. Endpoint: GET /conversation-ai/agents/{agentId}/actions/list (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.readonly

Inputs: agentId (required).

ghl_conversation_ai_search_agentA
Read-onlyIdempotent

Search Agents Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities. Endpoint: GET /conversation-ai/agents/search (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.readonly Pagination params: startAfter, limit — pass them to page through full result sets.

Inputs: limit, query, startAfter.

ghl_conversation_ai_update_actionA
Idempotent

Update Action Updates an existing action's configuration — name, description, trigger condition and behaviour settings. For customApi ("API Call") actions details.apiConfig is optional: omit it to leave the HTTP definition untouched. When sent, it is merged ONE LEVEL DEEP over the stored config — a top-level key you send replaces the stored value outright, keys you omit are kept. Nested values (headers, queryParams, bodyTemplate, parameters, outputFields) are replaced whole, so send the complete object rather than just the entry you changed. authentication is the exception: secret fields omitted, or returned as the redacted placeholder, keep the stored secret. Endpoint: PUT /conversation-ai/agents/{agentId}/actions/{actionId} (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: body (required), agentId (required), actionId (required).

ghl_conversation_ai_update_agentA
Idempotent

Update Agent Updates an existing AI agent's configuration. All fields in the agent configuration can be updated including name, status, actions, and behavior settings. Endpoint: PUT /conversation-ai/agents/{agentId} (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: body (required), agentId (required).

ghl_conversation_ai_update_agent_working_hoursA
Idempotent

Update Agent Working Hours Fully replaces the working-hours configuration for an AI agent. Returns 404 when none exists yet — use the create endpoint first. This is a replace, not a merge: omitted fields are not preserved. Endpoint: PUT /conversation-ai/agents/{agentId}/working-hours (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: body (required), agentId (required).

ghl_conversation_ai_update_followup_settingsB

Update Followup Settings Update the followup settings for an action Endpoint: PATCH /conversation-ai/agents/{agentId}/followup-settings (Version header: v3; source: v3/conversation-ai-v3.json) OAuth scopes: conversation-ai.write

Inputs: body (required), agentId (required).

ghl_conversation_cancel_scheduled_email_messageB
DestructiveIdempotent

Cancel a scheduled email message. Post the messageId for the API to delete a scheduled email message. Endpoint: DELETE /conversations/messages/email/{emailMessageId}/schedule (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: emailMessageId (required).

ghl_conversation_cancel_scheduled_messageA
DestructiveIdempotent

Cancel a scheduled message. Post the messageId for the API to delete a scheduled message. Endpoint: DELETE /conversations/messages/{messageId}/schedule (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: messageId (required).

ghl_conversation_createB

Create Conversation Creates a new conversation with the data provided Endpoint: POST /conversations/ (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations.write

Inputs: body (required).

ghl_conversation_create_custom_subtypeA

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Create Custom Subtype Create a new custom subtype for a location. Requires agency or account admin role. Endpoint: POST /conversations/preferences/custom-subtypes (Version header: 2021-04-15; source: conversations.json)

Inputs: body (required), locationId (required).

ghl_conversation_deleteB
DestructiveIdempotent

Delete Conversation Delete the conversation details based on the conversation ID Endpoint: DELETE /conversations/{conversationId} (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations.write

Inputs: conversationId (required).

ghl_conversation_download_message_transcriptionA
Read-onlyIdempotent

Response is NOT JSON — returns the transcription as a text/plain file download (Content-Disposition: attachment; filename="transcription.txt") per the spec's response headers, distinct from GET .../transcription (no /download) which returns a normal JSON object. Download transcription by Message ID Download the recording transcription for a message by passing the message id Endpoint: GET /conversations/locations/{locationId}/messages/{messageId}/transcription/download (Version header: v3; source: v3/conversations-v3.json) Requires a Sub-Account (location) token.

Inputs: messageId (required), locationId (required).

ghl_conversation_export_messages_by_locationA
Read-onlyIdempotent

Export messages by location ID Export messages for a specific location with cursor-based pagination support.

Channel Filtering Behavior:

  • When channel is omitted: Returns all non-email message types, including messages that don't belong to any specific channel.

  • When channel=Email: Returns email messages only.

  • When channel is specified (SMS, Call, WhatsApp, etc.): Returns messages for that specific channel.

Limitations:

  • Group Chat and SMS Review Request message types are not supported.

  • Activity messages (opportunity updates, appointments, etc.) are not included in the export. Use GET /conversations/{conversationId}/messages (Get messages by conversation id) to fetch them.

  • Cursor validity is 2 minutes from the last request made. Endpoint: GET /conversations/messages/export (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.readonly Pagination params: limit, cursor — pass them to page through full result sets.

Inputs: locationId (required), limit, cursor, sortBy, +6 more.

ghl_conversation_getB
Read-onlyIdempotent

Get Conversation Get the conversation details based on the conversation ID Endpoint: GET /conversations/{conversationId} (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations.readonly

Inputs: conversationId (required).

ghl_conversation_get_contact_unsubscription_statusA
Read-onlyIdempotent

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Contact Unsubscription Status Get all subscription statuses for a contact (all emails or specific email) Endpoint: GET /conversations/preferences/unsubscriptions/status (Version header: 2021-04-15; source: conversations.json)

Inputs: contactId (required), locationId (required), email.

ghl_conversation_get_email_messageA
Read-onlyIdempotent

Note: the official spec omits the id path-parameter declaration; this server infers it from the URL template (registry.ts fallback added 2026-07-16), so id (the email message ID) is a required argument here despite the spec gap. Get email by Id Endpoint: GET /conversations/messages/email/{id} (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.readonly

Inputs: id (required).

ghl_conversation_get_messageA
Read-onlyIdempotent

Note: the official spec omits the id path-parameter declaration; this server infers it from the URL template (registry.ts fallback added 2026-07-16), so id (the message ID) is a required argument here despite the spec gap. Get message by message id Get message by message id. Endpoint: GET /conversations/messages/{id} (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.readonly

Inputs: id (required).

ghl_conversation_get_message_recordingA
Read-onlyIdempotent

Response is NOT JSON — returns the raw recording as audio/x-wav (Content-Disposition: attachment; filename=audio.wav) per the spec's response headers. Callers must handle a binary/audio body, not a parsed JSON object. Get Recording by Message ID Get the recording for a message by passing the message id Endpoint: GET /conversations/messages/{messageId}/locations/{locationId}/recording (Version header: v3; source: v3/conversations-v3.json) Requires a Sub-Account (location) token.

Inputs: messageId (required), locationId (required).

ghl_conversation_get_messagesA
Read-onlyIdempotent

Get messages by conversation id Get messages by conversation id. Endpoint: GET /conversations/{conversationId}/messages (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.readonly Pagination params: lastMessageId, limit — pass them to page through full result sets.

Inputs: conversationId (required), type, limit, lastMessageId.

ghl_conversation_get_message_transcriptionA
Read-onlyIdempotent

Get transcription by Message ID Get the recording transcription for a message by passing the message id Endpoint: GET /conversations/locations/{locationId}/messages/{messageId}/transcription (Version header: v3; source: v3/conversations-v3.json) Requires a Sub-Account (location) token.

Inputs: messageId (required), locationId (required).

ghl_conversation_list_custom_subtypesA
Read-onlyIdempotent

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get All Custom Subtypes Get all custom subtypes for a location Endpoint: GET /conversations/preferences/custom-subtypes (Version header: 2021-04-15; source: conversations.json)

Inputs: locationId (required).

ghl_conversation_live_chat_agent_typingB

Agent/Ai-Bot is typing a message indicator for live chat Agent/AI-Bot will call this when they are typing a message in live chat message Endpoint: POST /conversations/providers/live-chat/typing (Version header: v3; source: v3/conversations-v3.json) Requires a Sub-Account (location) token. OAuth scopes: conversations/livechat.write

Inputs: body (required).

ghl_conversation_send_messageA

PHI-adjacent: sends a message on a real conversation thread. DELIBERATE OVERRIDE of the broken upstream spec (2026-08-26): the official conversations-v3.json declares subType as an empty object schema (the live API validates it as a string enum, so {} 422s with 'subType must be a valid enum value') and marks [type, subType, contactId, status] as required (forcing subType/status is what makes every call fail — a plain SMS needs only type + contactId + message). This tool therefore requires only type and contactId; subType and status are optional strings and are OMITTED from the outbound request entirely when not supplied (the API validates the key if present). The spec enumerates no valid subType values — pass one only if you know it from GHL docs. Populate type-appropriate fields alongside: message (+ fromNumber/toNumber) for SMS-style channels; html/subject/emailTo/emailCc for Email; attachments as URLs. If the spec extractor is re-run, keep this patchBody override — do not let regeneration silently restore the broken schema. Send a new message Post the necessary fields for the API to send a new message. Endpoint: POST /conversations/messages (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: body (required).

ghl_conversation_updateB
Idempotent

Update Conversation Update the conversation details based on the conversation ID Endpoint: PUT /conversations/{conversationId} (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations.write

Inputs: body (required), conversationId (required).

ghl_conversation_update_custom_subtypeA
Idempotent

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Update Custom Subtype Update or archive a custom subtype. Requires agency or account admin role. Endpoint: PUT /conversations/preferences/custom-subtypes/{id} (Version header: 2021-04-15; source: conversations.json)

Inputs: id (required), body (required), locationId (required).

ghl_conversation_update_email_message_statusA
Idempotent

Update email message status Update delivery events, per-recipient statuses, and the overall message status for an email sent via a custom conversation provider.

Authorization

  • Requires the conversations/message.write OAuth scope.

  • The calling OAuth app must own the conversation provider that originally sent the email.

  • Attempts to update emails sent via LC Email or Mailgun will return 403 Forbidden.

Updatable Fields

All request body fields are optional. Pass only what you need to update.

events — Aggregate delivery event counters (integers). Counters are merged into the existing values (not replaced). Setting a counter to 0 is treated as no-op and will not reset the stored value.

recipients — Per-recipient delivery statuses. Each entry maps a recipient email address to a MessageStatus value. Use failReason to capture bounce or rejection details when the status is failed.

status — The overall message status. Accepts any MessageStatus enum value.

Event Inference

The API automatically infers related events to maintain data consistency:

  • clicked, complained, unsubscribed, or replied → implies opened (set to 1 if not already provided and open tracking is enabled) and delivered (set to 1).

  • opened → implies delivered (set to 1 if not provided).

  • delivered, permanent_fail, or temporary_fail → implies accepted (set to 1 if not provided).

Timestamps

The API automatically records server-side timestamps on first oc Endpoint: PUT /conversations/messages/email/{emailMessageId}/status (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: body (required), emailMessageId (required).

ghl_conversation_update_message_statusC
Idempotent

Update message status Post the necessary fields for the API to update message status. Endpoint: PUT /conversations/messages/{messageId}/status (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: body (required), messageId (required).

ghl_conversation_upload_file_attachmentsA

multipart/form-data upload. The body schema below carries only the declared form fields (conversationId, contactId, locationId, attachmentUrls, chatServiceSid, isGroupSms) from UploadFilesDto — per the endpoint description, each file's binary content must ALSO be attached as a separate multipart part keyed fileAttachment (buffer), which is not represented in the JSON schema. Allowed file types per spec: JPG, JPEG, PNG, MP4, MPEG, ZIP, RAR, PDF, DOC, DOCX, TXT, MP3, WAV. Upload file attachments Post the necessary fields for the API to upload files. The files need to be a buffer with the key "fileAttachment". Note: One of conversationId or contactId must be provided. File Size Limits: Maximum file size: 5 MBMaximum files per upload: 5 Allowed file types: Images: JPG, JPEG, PNG, GIF, SVG, HEIC, AI Videos: MP4, MPEG, 3GP Audio: MP3, WAV, WAVE, AIFF, AIF, AIFC, GSM, ULAW, OGG, AAC, M4A, AMR Documents: PDF, DOC, DOCX, TXT, CSV, XLS, XLSX, PPT, PPTX, ODT Archives: ZIP, RAR Other: VCF, VCARD (contact files), ICS (calendar files) The API will return an object with the URLs Secure attachments: Set isSecureAttachment to true to upload the file as a secure attachment. This is currently supported for the email channel only; support for the remaining conversation channels is coming. A secure attachment is returned with a /files/d/{slug} URL that is publicly accessible for one hour after upload. After that window the attachment becomes private — to render, download, or retry access, extract the {slug} from the returned URL and call GET /files/d/{slug} with a bearer token Endpoint: POST /conversations/messages/upload (Version header: v3; source: v3/conversations-v3.json) OAuth scopes: conversations/message.write

Inputs: body (required).

ghl_conversation_user_subscription_changeA

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] User Subscription Change Process subscription change initiated by a user (admin/agent). Supports individual custom subscription changes and resub all functionality. Legal forms are automatically created for user-initiated resubscribe actions on custom subscriptions. Endpoint: POST /conversations/preferences/unsubscriptions/user-change (Version header: 2021-04-15; source: conversations.json)

Inputs: body (required).

ghl_countdown_create_timerA

COUNTDOWN TIMER API — timers belong to the access token's location. Create Countdown Timer Create a countdown timer for the access token's location Endpoint: POST /countdown-timer/timers (Version header: v3; source: v3/countdown-timer-v3.json) Requires a Sub-Account (location) token. OAuth scopes: countdown-timer/timer.write

Inputs: body (required).

ghl_countdown_delete_timerA
DestructiveIdempotent

COUNTDOWN TIMER API — timers belong to the access token's location. Delete Countdown Timer Soft-delete a countdown timer Endpoint: DELETE /countdown-timer/timers/{timerId} (Version header: v3; source: v3/countdown-timer-v3.json) Requires a Sub-Account (location) token. OAuth scopes: countdown-timer/timer.write

Inputs: timerId (required).

ghl_countdown_get_timerA
Read-onlyIdempotent

COUNTDOWN TIMER API — timers belong to the access token's location. Get Countdown Timer Get a countdown timer by ID Endpoint: GET /countdown-timer/timers/{timerId} (Version header: v3; source: v3/countdown-timer-v3.json) Requires a Sub-Account (location) token. OAuth scopes: countdown-timer/timer.readonly

Inputs: timerId (required), contactId.

ghl_countdown_list_timersA
Read-onlyIdempotent

COUNTDOWN TIMER API — timers belong to the access token's location. List Countdown Timers Get a paginated list of the countdown timers belonging to the access token's location Endpoint: GET /countdown-timer/timers (Version header: v3; source: v3/countdown-timer-v3.json) Requires a Sub-Account (location) token. OAuth scopes: countdown-timer/timer.readonly Pagination params: limit, skip — pass them to page through full result sets.

Inputs: name, skip, type, limit, +2 more.

ghl_countdown_list_timer_templatesA
Read-onlyIdempotent

COUNTDOWN TIMER API — timers belong to the access token's location. List Timer Templates Get the available countdown timer templates with their default design configuration Endpoint: GET /countdown-timer/templates (Version header: v3; source: v3/countdown-timer-v3.json) Requires a Sub-Account (location) token. OAuth scopes: countdown-timer/timer.readonly

Inputs: no named parameters.

ghl_countdown_update_timerB

COUNTDOWN TIMER API — timers belong to the access token's location. Update Countdown Timer Update an existing countdown timer Endpoint: PATCH /countdown-timer/timers/{timerId} (Version header: v3; source: v3/countdown-timer-v3.json) Requires a Sub-Account (location) token. OAuth scopes: countdown-timer/timer.write

Inputs: body (required), timerId (required).

ghl_course_createA

COURSES API — the {productId} path parameter is the course (product) id. Create Course Create a course in the location. Requires a Location token with courses.write. Accepts product columns and nested customizations. locationId, userId, id, originId, source, and processing are not accepted. Endpoint: POST /courses/products (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), locationId (required).

ghl_course_create_categoryA

COURSES API — the {productId} path parameter is the course (product) id. Create Category Create a category in a course. Requires a Location token with courses.write. Accepts category columns (title required). locationId, userId, productId, originId are not accepted. Endpoint: POST /courses/products/{productId}/categories (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), productId (required), locationId (required).

ghl_course_create_enrollmentA

COURSES API — the {productId} path parameter is the course (product) id. Enroll Contact Grant a contact access to a membership offer. Requires a Location token with courses.write. Send Version: v3. Uses POST smart-list/user with source public_api (not the queued attach-offer-user path). Returns 200 when already enrolled and 201 when newly attached. Login tokens are never returned. checkoutFrom public_api is not in membership paidSources, so these grants are omitted from Net Revenue paid filters. Default-offer rows return 404. Endpoint: POST /courses/enrollments (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), locationId (required).

ghl_course_create_lessonA

COURSES API — the {productId} path parameter is the course (product) id. Create Lesson Create a lesson. Requires title and categoryId. Accepts lesson columns. locationId, userId, productId, originId are not accepted. Requires a Location token with courses.write. Endpoint: POST /courses/products/{productId}/lessons (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), productId (required), locationId (required).

ghl_course_create_lesson_assignmentA

COURSES API — the {productId} path parameter is the course (product) id. Create Lesson Assignment Create an assignment on a lesson. Requires a Location token with courses.write. Send Version: v3. Path lessonId is sent to membership as postId. locationId, userId, and productId are not accepted in the body. Endpoint: POST /courses/products/{productId}/lessons/{lessonId}/assignment (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), lessonId (required), productId (required), locationId (required).

ghl_course_create_lesson_quizA

COURSES API — the {productId} path parameter is the course (product) id. Create Lesson Quiz Create a quiz on a lesson. Requires a Location token with courses.write. Send Version: v3. Path lessonId is sent to membership as postId. locationId, userId, and productId are not accepted in the body. Endpoint: POST /courses/products/{productId}/lessons/{lessonId}/quiz (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), lessonId (required), productId (required), locationId (required).

ghl_course_create_offerA

COURSES API — the {productId} path parameter is the course (product) id. Create Offer Create a membership offer. Requires a Location token with courses.write. Send Version: v3. Returns the full offer. source is always membership. locationId, userId, originId, and addProductToMembers are not accepted. Non-free type still requires payment integrations upstream. Endpoint: POST /courses/offers (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), locationId (required).

ghl_course_deleteA
DestructiveIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Delete Course Delete a course. Requires a Location token with courses.write. Endpoint: DELETE /courses/products/{productId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: productId (required), locationId (required).

ghl_course_delete_assignmentA
DestructiveIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Delete Assignment Delete an assignment. Requires a Location token with courses.write. Send Version: v3. Endpoint: DELETE /courses/products/{productId}/assignments/{assignmentId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: productId (required), locationId (required), assignmentId (required).

ghl_course_delete_categoryA
DestructiveIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Delete Category Delete a category. Requires a Location token with courses.write. Endpoint: DELETE /courses/products/{productId}/categories/{categoryId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: productId (required), categoryId (required), locationId (required).

ghl_course_delete_enrollmentA
DestructiveIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Revoke Enrollment Revoke a contact from a membership offer. Requires a Location token with courses.write. Send Version: v3. Uses DELETE smart-list/user (offer revoke, not product blacklist). Sibling products on the same offer are also revoked. Default-offer rows return 404. Endpoint: DELETE /courses/enrollments (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), locationId (required).

ghl_course_delete_lessonA
DestructiveIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Delete Lesson Delete a lesson. Requires a Location token with courses.write. Endpoint: DELETE /courses/products/{productId}/lessons/{lessonId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: lessonId (required), productId (required), locationId (required).

ghl_course_delete_offerA
DestructiveIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Delete Offer Delete a membership offer. Requires a Location token with courses.write. Send Version: v3. Endpoint: DELETE /courses/offers/{offerId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: offerId (required), locationId (required).

ghl_course_delete_quizA
DestructiveIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Delete Quiz Delete a quiz. Requires a Location token with courses.write. Send Version: v3. Endpoint: DELETE /courses/products/{productId}/quizzes/{quizId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: quizId (required), productId (required), locationId (required).

ghl_course_getA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Get Course Get a course by id. Requires a Location token with courses.readonly. Returns product columns and nested customizations. Endpoint: GET /courses/products/{productId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: productId (required), locationId (required).

ghl_course_get_assessmentA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Get Assessment Get one assessment submission. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/assessments/{assessmentId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: productId (required), locationId (required), assessmentId (required).

ghl_course_get_categoryA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Get Category Get a category by id. Requires a Location token with courses.readonly. Returns the full category object. Endpoint: GET /courses/products/{productId}/categories/{categoryId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: productId (required), categoryId (required), locationId (required).

ghl_course_get_lessonA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Get Lesson Get a lesson by id. Requires a Location token with courses.readonly. Returns the full lesson object. Endpoint: GET /courses/products/{productId}/lessons/{lessonId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: lessonId (required), productId (required), locationId (required).

ghl_course_get_lesson_assignmentA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Get Lesson Assignment Get the assignment for a lesson. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/lessons/{lessonId}/assignment (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: lessonId (required), productId (required), locationId (required).

ghl_course_get_lesson_quizA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Get Lesson Quiz Get the quiz for a lesson. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/lessons/{lessonId}/quiz (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: lessonId (required), productId (required), locationId (required).

ghl_course_get_offerA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. Get Offer Get a membership offer by id. Requires a Location token with courses.readonly. Send Version: v3. Default-offer rows (source other than membership) return 404. Endpoint: GET /courses/offers/{offerId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: offerId (required), locationId (required).

ghl_course_get_quiz_questionsA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Quiz Questions List questions for a quiz. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/quizzes/{quizId}/questions (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: quizId (required), productId (required), locationId (required).

ghl_course_importC

COURSES API — the {productId} path parameter is the course (product) id. Import Courses Import Courses through public channels Endpoint: POST /courses/courses-exporter/public/import (Version header: v3; source: v3/courses-v3.json)

Inputs: body (required).

ghl_course_listA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Courses List courses in the location. Requires a Location token with courses.readonly. Send Version: v3. Each item is the full course object including customizations. Endpoint: GET /courses/products (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly Pagination params: limit, cursor — pass them to page through full result sets.

Inputs: locationId (required), limit, cursor, search.

ghl_course_list_assessmentsA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Assessments List assessment submissions for a course. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/assessments (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly Pagination params: pageSize — pass them to page through full result sets.

Inputs: productId (required), locationId (required), status, pageSize, +1 more.

ghl_course_list_bulk_progressA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Product Progress Return progress for the given contact across productIds. Requires a Location token with courses.readonly. Send Version: v3. productIds is a comma-separated list of at most 50 UUID v4 product ids. Endpoint: GET /courses/progress (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: contactId (required), locationId (required), productIds (required).

ghl_course_list_categoriesA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Categories List categories for a course. Requires a Location token with courses.readonly. Each item is the full category object. Endpoint: GET /courses/products/{productId}/categories (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: productId (required), locationId (required).

ghl_course_list_category_progressA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Category Progress Return per-category progress for a contact in a product. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/categories/progress (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: contactId (required), productId (required), locationId (required).

ghl_course_list_completionsA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Completions With contactId, return that learner's completed lessons. Without contactId, return a paginated creator rollup by contact. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/completions (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly Pagination params: pageSize — pass them to page through full result sets.

Inputs: productId (required), locationId (required), pageSize, contactId, +1 more.

ghl_course_list_enrollmentsA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Product Enrollments List contacts enrolled in a product. Requires a Location token with courses.readonly. Send Version: v3. Reads user_purchases in the bound location. Does not return email or lesson progress. Cursor encodes createdAt and id. Endpoint: GET /courses/products/{productId}/enrollments (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly Pagination params: limit, cursor — pass them to page through full result sets.

Inputs: productId (required), locationId (required), limit, cursor.

ghl_course_list_lessonsA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Lessons List lessons for a course. Pass categoryId to list one category; omit it to list every category (N+1 membership reads). Requires a Location token with courses.readonly. Each item is the full lesson object. Endpoint: GET /courses/products/{productId}/lessons (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Inputs: productId (required), locationId (required), categoryId.

ghl_course_list_offersA
Read-onlyIdempotent

COURSES API — the {productId} path parameter is the course (product) id. List Offers List membership offers in the location. Requires a Location token with courses.readonly. Send Version: v3. Uses membership listView pagination (cursor encodes skip). Location-wide — membership does not filter by productId. Default-offer rows are not included. Endpoint: GET /courses/offers (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly Pagination params: limit, cursor — pass them to page through full result sets.

Inputs: locationId (required), limit, cursor, search, +1 more.

ghl_course_review_assessmentA
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Review Assessment Review an assessment submission. Requires a Location token with courses.write. Send Version: v3. Location tokens are not a staff reviewer. Endpoint: PUT /courses/products/{productId}/assessments/{assessmentId}/review (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), productId (required), locationId (required), assessmentId (required).

ghl_course_sequence_categoriesA
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Sequence Categories Reorder categories in a course. Requires a Location token with courses.write. Endpoint: PUT /courses/products/{productId}/categories/sequence (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), productId (required), locationId (required).

ghl_course_sequence_lessonsA
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Sequence Lessons Reorder lessons in a category. Requires a Location token with courses.write. Endpoint: PUT /courses/products/{productId}/categories/{categoryId}/lessons/sequence (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), productId (required), categoryId (required), locationId (required).

ghl_course_updateB
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Update Course Update a course. Requires a Location token with courses.write. Accepts the same product columns and nested customizations as create. All fields optional. Endpoint: PUT /courses/products/{productId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), productId (required), locationId (required).

ghl_course_update_assignmentA
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Update Assignment Update an assignment. Requires a Location token with courses.write. Send Version: v3. Endpoint: PUT /courses/products/{productId}/assignments/{assignmentId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), productId (required), locationId (required), assignmentId (required).

ghl_course_update_categoryA
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Update Category Update a category. Requires a Location token with courses.write. Accepts the same category columns as create. All fields optional. Endpoint: PUT /courses/products/{productId}/categories/{categoryId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), productId (required), categoryId (required), locationId (required).

ghl_course_update_lessonA
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Update Lesson Update a lesson. Requires a Location token with courses.write. Accepts the same lesson columns as create. All fields optional. Omit categoryId to keep the current category. Endpoint: PUT /courses/products/{productId}/lessons/{lessonId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), lessonId (required), productId (required), locationId (required).

ghl_course_update_offerB
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Update Offer Update a membership offer. Requires a Location token with courses.write. Send Version: v3. Returns the full offer. locationId, id, userId, originId, and addProductToMembers are not accepted. Endpoint: PUT /courses/offers/{offerId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), offerId (required), locationId (required).

ghl_course_update_quizA
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Update Quiz Update a quiz. Requires a Location token with courses.write. Send Version: v3. Endpoint: PUT /courses/products/{productId}/quizzes/{quizId} (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), quizId (required), productId (required), locationId (required).

ghl_course_upsert_quiz_questionsA
Idempotent

COURSES API — the {productId} path parameter is the course (product) id. Replace Quiz Questions Batch upsert quiz questions. Requires a Location token with courses.write. Send Version: v3. quizId is taken from the path, not the body. Endpoint: PUT /courses/products/{productId}/quizzes/{quizId}/questions (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Inputs: body (required), quizId (required), productId (required), locationId (required).

ghl_custom_field_createA

Create Custom Field

Inputs: body (required).

ghl_custom_field_create_folderA

Create Custom Field Folder

Inputs: body (required).

ghl_custom_field_deleteB
DestructiveIdempotent

Delete Custom Field By Id

Inputs: id (required).

ghl_custom_field_delete_folderC
DestructiveIdempotent

Delete Custom Field Folder

Inputs: id (required), locationId (required).

ghl_custom_field_get_by_idA
Read-onlyIdempotent

Also returns custom field FOLDERS by the same id (per the spec's own summary: 'Get Custom Field / Folder By Id') — check the response shape to tell which you got. Get Custom Field / Folder By Id

Inputs: id (required).

ghl_custom_field_get_by_object_keyA
Read-onlyIdempotent

Get Custom Fields By Object Key

Inputs: objectKey (required), locationId (required).

ghl_custom_field_updateA
Idempotent

Per spec (UpdateCustomFieldsDTO), locationId and showInForms are both required on every update call, even ones that only change name/description/options — this is a genuine spec requirement, not an extraction artifact. Update Custom Field By Id

Inputs: id (required), body (required).

ghl_custom_field_update_folderC
Idempotent

Update Custom Field Folder Name

Inputs: id (required), body (required).

ghl_custom_menu_createA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Create Custom Menu Link Creates a new custom menu for a company. Requires authentication and proper permissions. For Icon Usage Details please refer to https://doc.clickup.com/8631005/d/h/87cpx-243696/d60fa70db6b92b2 Endpoint: POST /custom-menus/ (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.write

Inputs: body (required).

ghl_custom_menu_deleteA
DestructiveIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Delete Custom Menu Link Removes a specific custom menu from the system. This operation requires authentication and proper permissions. The custom menu is identified by its unique ID, and the operation is performed within the context of a specific company. Endpoint: DELETE /custom-menus/{customMenuId} (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.write

Inputs: customMenuId (required).

ghl_custom_menu_get_by_idA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Get Custom Menu Link Fetches a single custom menus based on id. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata Endpoint: GET /custom-menus/{customMenuId} (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.readonly

Inputs: customMenuId (required).

ghl_custom_menu_listA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Get Custom Menu Links Fetches a collection of custom menus based on specified criteria. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata. The response can be tailored using query parameters for filtering, sorting, and pagination. Endpoint: GET /custom-menus/ (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: skip, limit, query, locationId, +1 more.

ghl_custom_menu_updateA
Idempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Update Custom Menu Link Updates an existing custom menu for a given company. Requires authentication and proper permissions. Endpoint: PUT /custom-menus/{customMenuId} (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.write

Inputs: body (required), customMenuId (required).

ghl_email_builder_template_createA

Legacy 'Email Builder' template API (2021-era, distinct from the v3 template family below — different data model, not interchangeable). [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Create a new template Endpoint: POST /emails/builder (Version header: 2021-07-28; source: emails.json) Requires a Sub-Account (location) token. OAuth scopes: emails/builder.write

Inputs: body (required).

ghl_email_builder_template_deleteA
DestructiveIdempotent

Legacy 'Email Builder' template API (2021-era, distinct from the v3 template family below — different data model, not interchangeable). [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Delete a template Endpoint: DELETE /emails/builder/{locationId}/{templateId} (Version header: 2021-07-28; source: emails.json) Requires a Sub-Account (location) token.

Inputs: locationId (required), templateId (required).

ghl_email_builder_template_getA
Read-onlyIdempotent

Legacy 'Email Builder' template API (2021-era, distinct from the v3 template family below — different data model, not interchangeable). [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Fetch email templates Fetch email templates by location id Endpoint: GET /emails/builder (Version header: 2021-07-28; source: emails.json) Requires a Sub-Account (location) token. OAuth scopes: emails/builder.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), name, limit, offset, +7 more.

ghl_email_builder_template_updateA

Legacy 'Email Builder' template API (2021-era, distinct from the v3 template family below — different data model, not interchangeable). [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Update a template Endpoint: POST /emails/builder/data (Version header: 2021-07-28; source: emails.json) Requires a Sub-Account (location) token. OAuth scopes: emails/builder.write

Inputs: body (required).

ghl_email_create_campaignA

Create Email Campaign Create a new email campaign Endpoint: POST /emails/locations/{locationId}/campaigns/emails (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.write

Inputs: body (required), locationId (required).

ghl_email_delete_campaignA
DestructiveIdempotent

Delete Campaign Delete a campaign Endpoint: DELETE /emails/locations/{locationId}/campaigns/emails/{campaignId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.write

Inputs: campaignId (required), locationId (required).

ghl_email_get_bulk_action_campaignA
Read-onlyIdempotent

Get Bulk Action Campaign by ID Get a single bulk action campaign by its ID Endpoint: GET /emails/locations/{locationId}/campaigns/bulk-actions/{campaignId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.readonly

Inputs: campaignId (required), locationId (required).

ghl_email_get_campaignA
Read-onlyIdempotent

Get Email Campaign by ID Get a single email campaign by its ID Endpoint: GET /emails/locations/{locationId}/campaigns/emails/{campaignId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.readonly

Inputs: campaignId (required), locationId (required).

ghl_email_get_campaign_statsA
Read-onlyIdempotent

Get Campaign Statistics Get statistics for email campaigns, workflows, or bulk actions Endpoint: GET /emails/locations/{locationId}/campaigns/stats/{source}/{sourceId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/stats.readonly

Inputs: source (required), sourceId (required), locationId (required), subSourceId.

ghl_email_get_workflow_campaignA
Read-onlyIdempotent

Get Workflow Campaign by ID Get a single workflow campaign by its ID Endpoint: GET /emails/locations/{locationId}/campaigns/workflows/{campaignId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.readonly

Inputs: campaignId (required), locationId (required).

ghl_email_legacy_campaign_listA
Read-onlyIdempotent

Legacy schedule/campaign listing (2021-era, distinct from the v3 campaign family at /emails/locations/{locationId}/campaigns/emails). Supports limit/offset pagination plus status and emailStatus filters. [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Campaigns Endpoint: GET /emails/schedule (Version header: 2021-07-28; source: emails.json) Requires a Sub-Account (location) token. OAuth scopes: emails/schedule.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), name, limit, offset, +7 more.

ghl_email_list_bulk_action_campaignsA
Read-onlyIdempotent

List Bulk Action Campaigns Get list of bulk action campaigns for a location Endpoint: GET /emails/locations/{locationId}/campaigns/bulk-actions (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), limit, dateTo, offset, +3 more.

ghl_email_list_campaignsA
Read-onlyIdempotent

List Email Campaigns Get list of email campaigns for a location Endpoint: GET /emails/locations/{locationId}/campaigns/emails (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), limit, offset, search, +1 more.

ghl_email_list_workflow_campaignsA
Read-onlyIdempotent

List Workflow Campaigns Get list of workflow campaigns for a location Endpoint: GET /emails/locations/{locationId}/campaigns/workflows (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), limit, offset, search, +1 more.

ghl_email_schedule_campaignA

Schedule Campaign Schedule or start an email campaign. The campaign must be in draft, cancelled, or paused status. Endpoint: POST /emails/locations/{locationId}/campaigns/emails/{campaignId}/schedule (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.write

Inputs: body (required), campaignId (required), locationId (required).

ghl_email_template_createB

Create an email template Create a new email template Endpoint: POST /emails/locations/{locationId}/templates (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/templates.write

Inputs: body (required), locationId (required).

ghl_email_template_deleteA
DestructiveIdempotent

Delete a template Endpoint: DELETE /emails/locations/{locationId}/templates/{templateId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/templates.write

Inputs: locationId (required), templateId (required).

ghl_email_template_folder_createB

Create a template folder Create a new template folder Endpoint: POST /emails/locations/{locationId}/templates/folders (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/templates.write

Inputs: body (required), locationId (required).

ghl_email_template_getA
Read-onlyIdempotent

Get Email Template by ID Get a single email template by its ID Endpoint: GET /emails/locations/{locationId}/templates/{templateId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/templates.readonly

Inputs: locationId (required), templateId (required).

ghl_email_template_importA

Import an email template Import a template from a provider URL Endpoint: POST /emails/locations/{locationId}/templates/import (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/templates.write

Inputs: body (required), locationId (required).

ghl_email_template_listA
Read-onlyIdempotent

List templates Get list of templates by location Endpoint: GET /emails/locations/{locationId}/templates (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/templates.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), limit, offset, search, +5 more.

ghl_email_template_updateB

Update an email template Update email template Endpoint: PATCH /emails/locations/{locationId}/templates/{templateId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/templates.write

Inputs: body (required), locationId (required), templateId (required).

ghl_email_update_campaignA

Update Email Campaign Update an email campaign draft Endpoint: PATCH /emails/locations/{locationId}/campaigns/emails/{campaignId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.write

Inputs: body (required), campaignId (required), locationId (required).

ghl_email_verifyB

Email Verification Verify Email Endpoint: POST /email/verify (Version header: v3; source: v3/email-isv-v3.json) Requires a Sub-Account (location) token. OAuth scopes: lc-email.readonly

Inputs: body (required), locationId (required).

ghl_estimate_convert_to_invoiceB

Creates a new invoice from an accepted/existing estimate. Create Invoice from Estimate Create a new invoice from an existing estimate Endpoint: POST /invoices/estimate/{estimateId}/invoice (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.write

Inputs: body (required), estimateId (required).

ghl_estimate_createB

Create New Estimate Create a new estimate with the provided details Endpoint: POST /invoices/estimate (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.write

Inputs: body (required).

ghl_estimate_deleteA
DestructiveIdempotent

Delete Estimate Delete an existing estimate Endpoint: DELETE /invoices/estimate/{estimateId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.write

Inputs: body (required), estimateId (required).

ghl_estimate_generate_numberA
Read-onlyIdempotent

Generate Estimate Number Get the next estimate number for the given location Endpoint: GET /invoices/estimate/number/generate (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.readonly

Inputs: altId (required), altType (required).

ghl_estimate_listA
Read-onlyIdempotent

List Estimates Get a paginated list of estimates Endpoint: GET /invoices/estimate/list (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), limit (required), offset (required), altType (required), +5 more.

ghl_estimate_sendA

Send Estimate API to send estimate by estimate id Endpoint: POST /invoices/estimate/{estimateId}/send (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.write

Inputs: body (required), estimateId (required).

ghl_estimate_template_createA

Create Estimate Template Create a new estimate template Endpoint: POST /invoices/estimate/template (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.write

Inputs: body (required).

ghl_estimate_template_deleteB
DestructiveIdempotent

Delete Estimate Template Delete an existing estimate template Endpoint: DELETE /invoices/estimate/template/{templateId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.write

Inputs: body (required), templateId (required).

ghl_estimate_template_listA
Read-onlyIdempotent

List Estimate Templates Get a list of estimate templates or a specific template by ID Endpoint: GET /invoices/estimate/template (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), limit (required), offset (required), altType (required), +1 more.

ghl_estimate_template_previewA
Read-onlyIdempotent

Preview Estimate Template Get a preview of an estimate template Endpoint: GET /invoices/estimate/template/preview (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.readonly

Inputs: altId (required), altType (required), templateId (required).

ghl_estimate_template_updateA
Idempotent

Update Estimate Template Update an existing estimate template Endpoint: PUT /invoices/estimate/template/{templateId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.write

Inputs: body (required), templateId (required).

ghl_estimate_updateA
Idempotent

Update Estimate Update an existing estimate with new details Endpoint: PUT /invoices/estimate/{estimateId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/estimate.write

Inputs: body (required), estimateId (required).

ghl_estimate_update_last_visited_atC

Update estimate last visited at API to update estimate last visited at by estimate id Endpoint: PATCH /invoices/estimate/stats/last-visited-at (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token.

Inputs: body (required).

ghl_file_get_by_slugA
Read-onlyIdempotent

FILES API — resolves a share-link slug to the file (sub-account token, files.readonly). Get File Get the file by slug. Endpoint: GET /files/d/{slug} (Version header: v3; source: v3/files-v3.json) OAuth scopes: files.readonly

Inputs: slug (required).

ghl_form_get_submissionsB
Read-onlyIdempotent

Get Forms Submissions Endpoint: GET /forms/submissions (Version header: v3; source: v3/forms-v3.json) OAuth scopes: forms.readonly Pagination params: page, limit — pass them to page through full result sets.

Inputs: locationId (required), q, page, endAt, +3 more.

ghl_form_listB
Read-onlyIdempotent

Get Forms Endpoint: GET /forms/ (Version header: v3; source: v3/forms-v3.json) OAuth scopes: forms.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), skip, type, limit.

ghl_form_upload_custom_filesA

EXCEPTION — no callable body schema: the official spec documents this endpoint's multipart/form-data requestBody as a bare empty object (no fields listed), so this tool's generated input schema has NO body property at all; there is currently no way to attach file bytes through this tool. Per the spec's prose, fields must be a buffer keyed <custom_field_id>_<file_id> (custom field ID + a random file id), max 50MB, one of PDF/DOCX/DOC/JPG/JPEG/PNG/GIF/CSV/XLSX/XLS/MP4/MPEG/ZIP/RAR/TXT/SVG. Fixing this requires a registry.ts change (a hand-written schema override capability that doesn't exist yet), which is out of scope for this docs-only override pass — flagged as an exception in the audit. Upload files to custom fields Post the necessary fields for the API to upload files. The files need to be a buffer with the key "< custom_field_id >_< file_id >". Here custom field id is the ID of your custom field and file id is a randomly generated id (or uuid) There is support for multiple file uploads as well. Have multiple fields in the format mentioned.File size is limited to 50 MB. The allowed file types are: PDFDOCXDOCJPGJPEGPNGGIFCSVXLSXXLSMP4MPEGZIPRARTXTSVG The API will return the updated contact object. Endpoint: POST /forms/upload-custom-files (Version header: v3; source: v3/forms-v3.json) Requires a Sub-Account (location) token. OAuth scopes: forms.write

Inputs: body (required), contactId (required), locationId (required).

ghl_funnel_create_redirectB

Create Redirect The "Create Redirect" API Allows adding a new url redirect to the system. Use this endpoint to create a url redirect with the specified details. Ensure that the required information is provided in the request payload. Endpoint: POST /funnels/lookup/redirect (Version header: v3; source: v3/funnels-v3.json) Requires a Sub-Account (location) token. OAuth scopes: funnels/redirect.write

Inputs: body (required).

ghl_funnel_delete_redirect_by_idA
DestructiveIdempotent

Delete Redirect By Id The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system using its unique identifier. Use this endpoint to delete a URL redirect with the specified ID using details provided in the request payload. Endpoint: DELETE /funnels/lookup/redirect/{id} (Version header: v3; source: v3/funnels-v3.json) Requires a Sub-Account (location) token. OAuth scopes: funnels/redirect.write

Inputs: id (required), locationId (required).

ghl_funnel_fetch_redirects_listA
Read-onlyIdempotent

Fetch List of Redirects Retrieves a list of all URL redirects based on the given query parameters. Endpoint: GET /funnels/lookup/redirect/list (Version header: v3; source: v3/funnels-v3.json) Requires a Sub-Account (location) token. OAuth scopes: funnels/redirect.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: limit (required), offset (required), locationId (required), search.

ghl_funnel_get_pages_by_idB
Read-onlyIdempotent

Fetch list of funnel pages Retrieves a list of all funnel pages based on the given query parameters. Endpoint: GET /funnels/page (Version header: v3; source: v3/funnels-v3.json) Requires a Sub-Account (location) token. Pagination params: limit, offset — pass them to page through full result sets.

Inputs: limit (required), offset (required), funnelId (required), locationId (required), +1 more.

ghl_funnel_get_pages_count_by_idB
Read-onlyIdempotent

Fetch count of funnel pages Retrieves count of all funnel pages based on the given query parameters. Endpoint: GET /funnels/page/count (Version header: v3; source: v3/funnels-v3.json) Requires a Sub-Account (location) token.

Inputs: funnelId (required), locationId (required), name.

ghl_funnel_listB
Read-onlyIdempotent

Fetch List of Funnels Retrieves a list of all funnels based on the given query parameters. Endpoint: GET /funnels/funnel/list (Version header: v3; source: v3/funnels-v3.json) Requires a Sub-Account (location) token. Pagination params: offset, limit — pass them to page through full result sets.

Inputs: locationId (required), name, type, limit, +3 more.

ghl_funnel_update_redirect_by_idB

Update Redirect By Id The "Update Redirect By Id" API Allows updating an existing URL redirect in the system. Use this endpoint to modify a URL redirect with the specified ID using details provided in the request payload. Endpoint: PATCH /funnels/lookup/redirect/{id} (Version header: v3; source: v3/funnels-v3.json) Requires a Sub-Account (location) token. OAuth scopes: funnels/redirect.write

Inputs: id (required), body (required).

ghl_invoice_createB

Create Invoice API to create an invoice Endpoint: POST /invoices/ (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.write

Inputs: body (required).

ghl_invoice_deleteA
DestructiveIdempotent

Delete invoice API to delete invoice by invoice id Endpoint: DELETE /invoices/{invoiceId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.write

Inputs: altId (required), altType (required), invoiceId (required).

ghl_invoice_generate_numberA
Read-onlyIdempotent

Generate Invoice Number Get the next invoice number for the given location Endpoint: GET /invoices/generate-invoice-number (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.readonly

Inputs: altId (required), altType (required).

ghl_invoice_getA
Read-onlyIdempotent

Get invoice API to get invoice by invoice id Endpoint: GET /invoices/{invoiceId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.readonly

Inputs: altId (required), altType (required), invoiceId (required).

ghl_invoice_get_settingsA
Read-onlyIdempotent

Get Invoice Settings Get the invoice settings for the given location Endpoint: GET /invoices/settings (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.readonly

Inputs: altId (required), altType (required).

ghl_invoice_listA
Read-onlyIdempotent

List invoices API to get list of invoices Endpoint: GET /invoices/ (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), limit (required), offset (required), altType (required), +8 more.

ghl_invoice_record_paymentA

Records a manual/offline payment against an invoice (e.g. cash, check). Does not process a live charge. Record a manual payment for an invoice API to record manual payment for an invoice by invoice id Endpoint: POST /invoices/{invoiceId}/record-payment (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.write

Inputs: body (required), invoiceId (required).

ghl_invoice_schedule_activateA

Activates (starts sending) a previously created but not-yet-scheduled recurring invoice. Schedule an schedule invoice API to schedule an schedule invoice to start sending to the customer Endpoint: POST /invoices/schedule/{scheduleId}/schedule (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.write

Inputs: body (required), scheduleId (required).

ghl_invoice_schedule_cancelA

Stops all remaining not-yet-sent occurrences of this recurring/scheduled invoice. Already-sent invoices are unaffected. Cancel an scheduled invoice API to cancel a scheduled invoice by schedule id Endpoint: POST /invoices/schedule/{scheduleId}/cancel (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.write

Inputs: body (required), scheduleId (required).

ghl_invoice_schedule_createB

Create Invoice Schedule API to create an invoice Schedule Endpoint: POST /invoices/schedule (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.write

Inputs: body (required).

ghl_invoice_schedule_deleteB
DestructiveIdempotent

Delete schedule API to delete an schedule by schedule id Endpoint: DELETE /invoices/schedule/{scheduleId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.write

Inputs: altId (required), altType (required), scheduleId (required).

ghl_invoice_schedule_getA
Read-onlyIdempotent

Get an schedule API to get an schedule by schedule id Endpoint: GET /invoices/schedule/{scheduleId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.readonly

Inputs: altId (required), altType (required), scheduleId (required).

ghl_invoice_schedule_listB
Read-onlyIdempotent

List schedules API to get list of schedules Endpoint: GET /invoices/schedule (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), limit (required), offset (required), altType (required), +5 more.

ghl_invoice_schedule_set_auto_paymentA

Manage Auto payment for an schedule invoice API to manage auto payment for a schedule Endpoint: POST /invoices/schedule/{scheduleId}/auto-payment (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.write

Inputs: body (required), scheduleId (required).

ghl_invoice_schedule_updateB
Idempotent

Update schedule API to update an schedule by schedule id Endpoint: PUT /invoices/schedule/{scheduleId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.write

Inputs: body (required), scheduleId (required).

ghl_invoice_schedule_update_and_activateC

Update scheduled recurring invoice API to update scheduled recurring invoice Endpoint: POST /invoices/schedule/{scheduleId}/updateAndSchedule (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.write

Inputs: scheduleId (required).

ghl_invoice_sendB

Send invoice API to send invoice by invoice id Endpoint: POST /invoices/{invoiceId}/send (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.write

Inputs: body (required), invoiceId (required).

ghl_invoice_template_createB

Create template API to create a template Endpoint: POST /invoices/template (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/template.write

Inputs: body (required).

ghl_invoice_template_deleteB
DestructiveIdempotent

Delete template API to update an template by template id Endpoint: DELETE /invoices/template/{templateId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/template.write

Inputs: altId (required), altType (required), templateId (required).

ghl_invoice_template_getB
Read-onlyIdempotent

Get an template API to get an template by template id Endpoint: GET /invoices/template/{templateId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/template.readonly

Inputs: altId (required), altType (required), templateId (required).

ghl_invoice_template_listB
Read-onlyIdempotent

List templates API to get list of templates Endpoint: GET /invoices/template (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/template.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), limit (required), offset (required), altType (required), +5 more.

ghl_invoice_template_updateB
Idempotent

Update template API to update an template by template id Endpoint: PUT /invoices/template/{templateId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/template.write

Inputs: body (required), templateId (required).

ghl_invoice_template_update_late_fees_configurationB

Update template late fees configuration API to update template late fees configuration by template id Endpoint: PATCH /invoices/template/{templateId}/late-fees-configuration (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token.

Inputs: body (required), templateId (required).

ghl_invoice_template_update_payment_methods_configurationC

Updates which payment methods are enabled on invoices created from this template. Update template late fees configuration API to update template late fees configuration by template id Endpoint: PATCH /invoices/template/{templateId}/payment-methods-configuration (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token.

Inputs: body (required), templateId (required).

ghl_invoice_text2payA

Create & Send API to create or update a text2pay invoice Endpoint: POST /invoices/text2pay (Version header: v3; source: v3/invoices-v3.json) Requires a Sub-Account (location) token. OAuth scopes: invoices.write

Inputs: body (required).

ghl_invoice_updateB
Idempotent

Update invoice API to update invoice by invoice id Endpoint: PUT /invoices/{invoiceId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.write

Inputs: body (required), invoiceId (required).

ghl_invoice_update_last_visited_atB

Update invoice last visited at API to update invoice last visited at by invoice id Endpoint: PATCH /invoices/stats/last-visited-at (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token.

Inputs: body (required).

ghl_invoice_update_late_fees_configurationA

Update invoice late fees configuration API to update invoice late fees configuration by invoice id Endpoint: PATCH /invoices/{invoiceId}/late-fees-configuration (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token.

Inputs: body (required), invoiceId (required).

ghl_invoice_voidB

Irreversible: marks the invoice as void. A voided invoice cannot be paid or reactivated afterward. Void invoice API to delete invoice by invoice id Endpoint: POST /invoices/{invoiceId}/void (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.write

Inputs: body (required), invoiceId (required).

ghl_kb_crawler_delete_urlsA
DestructiveIdempotent

Delete trained pages Removes trained website pages from a knowledge base so the AI no longer references them. WHEN TO USE: use this when you need to drop specific or all trained URLs; use trainDiscoveredUrls to add pages; use getAllWebsiteUrlsDataByKnowledgeBase to list what is trained. RETURNS: whether the delete succeeded. Endpoint: DELETE /knowledge-bases/crawler (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: body (required).

ghl_kb_crawler_discoverA

Start crawling and discover pages for training Starts a website crawl that discovers pages for later AI training. WHEN TO USE: use this when you need to scan a site before training; use trainDiscoveredUrls to ingest selected pages; use getCrawlingStatusForLatestOperation to poll progress. RETURNS: the discovery operation id, current status, and the URL being crawled. Endpoint: POST /knowledge-bases/crawler (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: body (required).

ghl_kb_crawler_list_urlsA
Read-onlyIdempotent

Get all trained page links by knowledge base Lists discovered and trained website pages for a knowledge base, with pagination and optional URL filter. WHEN TO USE: use this when you need to inspect crawled pages; use discoverWebsite to find new pages; use deleteTrainedUrlsForKnowledgeBase to remove pages the AI should stop using. RETURNS: a paginated list of crawled URLs with status, title, and identifiers. Endpoint: GET /knowledge-bases/crawler (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly Pagination params: page, pageLength — pass them to page through full result sets.

Inputs: locationId (required), knowledgeBaseId (required), page, query, +1 more.

ghl_kb_crawler_statusA
Read-onlyIdempotent

Get crawling status for the latest operation Fetches crawl/train progress for a specific operation, or the latest operation when operationId is omitted. WHEN TO USE: use this when you need to poll a discoverWebsite or trainDiscoveredUrls run; do not use it to start a crawl or train pages. RETURNS: aggregated counts by status plus detailed operation information. Endpoint: GET /knowledge-bases/crawler/status (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly

Inputs: locationId (required), knowledgeBaseId (required), operationId.

ghl_kb_crawler_trainA

Train discovered website pages and ingest into the knowledge base Queues selected discovered pages so the AI ingests their content into the knowledge base. WHEN TO USE: use this when discoverWebsite has already found pages; use discoverWebsite to crawl first; use deleteTrainedUrlsForKnowledgeBase to untrain pages. RETURNS: whether training was queued, a status message, and the URL ids that were accepted. Endpoint: POST /knowledge-bases/crawler/train (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: body (required).

ghl_kb_create_knowledge_baseA

Create a new knowledge base (max 15 knowledge bases per location) Creates a new knowledge base for a location (maximum 15 per location). WHEN TO USE: use this when you need to add a brand-new knowledge source; use updateKnowledgeBase to rename one; use create (FAQs) or trainDiscoveredUrls to add content. RETURNS: success and the created knowledge base, including its server-assigned id. Endpoint: POST /knowledge-bases/ (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: body (required).

ghl_kb_delete_fileA
DestructiveIdempotent

Delete a file from knowledge base Deletes one uploaded file from the authenticated location so the AI no longer uses it. WHEN TO USE: use this when you need to remove a document; use getFilesByKnowledgeBasePublic to find the file id; use deleteTrainedUrlsForKnowledgeBase for crawled pages instead. RETURNS: whether the delete succeeded. Endpoint: DELETE /knowledge-bases/files/{fileId} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: fileId (required).

ghl_kb_delete_knowledge_baseA
DestructiveIdempotent

Delete a knowledge base Permanently deletes a knowledge base and its associated trained content. WHEN TO USE: use this when the whole knowledge source is no longer needed; use deleteTrainedUrlsForKnowledgeBase or delete (FAQ) to remove only some content. RETURNS: whether the delete succeeded. Endpoint: DELETE /knowledge-bases/{knowledgeBaseId} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: knowledgeBaseId (required).

ghl_kb_faq_createA

Create a new FAQ inside knowledge base Creates a new question-and-answer entry in a knowledge base. WHEN TO USE: use this when you need to add a brand-new FAQ; use update to change an existing one; use list to see current FAQs. RETURNS: success and the created FAQ, including its server-assigned id. Endpoint: POST /knowledge-bases/faqs (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: body (required).

ghl_kb_faq_deleteA
DestructiveIdempotent

Delete an existing knowledge base FAQ Permanently deletes one FAQ from a knowledge base. WHEN TO USE: use this when a canned answer is outdated; use update to revise it instead; use list to find the FAQ id. RETURNS: whether the delete succeeded. Endpoint: DELETE /knowledge-bases/faqs/{id} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: id (required).

ghl_kb_faq_listA
Read-onlyIdempotent

Get all FAQs by knowledge base with pagination support Retrieves Q&A entries for a knowledge base, with cursor or offset pagination and optional question search. WHEN TO USE: use this when you need to list existing FAQs; use create to add one; use update or delete to change or remove a single FAQ. RETURNS: the FAQ list, total count, lastFaqId for the next page, and whether more results exist. Endpoint: GET /knowledge-bases/faqs (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly Pagination params: limit, lastFaqId, offset — pass them to page through full result sets.

Inputs: locationId (required), knowledgeBaseId (required), limit, offset, +2 more.

ghl_kb_faq_updateA
Idempotent

Update an existing knowledge base FAQ Updates the question and/or answer of an existing FAQ. WHEN TO USE: use this when you need to change wording on a FAQ you already have; use create to add a new FAQ; use delete to remove one. RETURNS: whether the update succeeded. Endpoint: PUT /knowledge-bases/faqs/{id} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: id (required), body (required).

ghl_kb_get_file_by_idA
Read-onlyIdempotent

Get file by id Retrieves one uploaded file by id for the authenticated location. WHEN TO USE: use this when you need to inspect a single file; use getFilesByKnowledgeBasePublic to list files; use deleteFile to remove it. RETURNS: uploaded file details for that file id. Endpoint: GET /knowledge-bases/files/{fileId} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly

Inputs: fileId (required).

ghl_kb_get_files_by_knowledge_base_publicA
Read-onlyIdempotent

Get all files by knowledge base Lists files uploaded to a knowledge base, with optional pagination and name search. WHEN TO USE: use this when you need to see uploaded documents; use uploadFile to add a file; use getFileById for one file; use deleteFile to remove one. RETURNS: the file list for the knowledge base. Endpoint: GET /knowledge-bases/files (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: knowledgeBaseId (required), limit, offset, search, +1 more.

ghl_kb_get_knowledge_base_by_idA
Read-onlyIdempotent

Get knowledge base by ID Retrieves one knowledge base by id, including name, metadata, and timestamps. WHEN TO USE: use this when you need to inspect a single knowledge base; use listAllKnowledgeBasesPaginated to browse; use updateKnowledgeBase to rename it. RETURNS: success and the knowledge base record. Endpoint: GET /knowledge-bases/{knowledgeBaseId} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly

Inputs: knowledgeBaseId (required).

ghl_kb_get_sitemap_previewA

Preview Sitemap URLs Returns a paginated, searchable list of sitemap URLs without starting a crawl. WHEN TO USE: use this when you need to preview sitemap URLs before a crawl; use discoverWebsite to start discovery; use trainDiscoveredUrls after pages are found. RETURNS: a paginated list of sitemap URLs. Endpoint: POST /knowledge-bases/crawler/sitemap-preview (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly

Inputs: body (required).

ghl_kb_listA
Read-onlyIdempotent

Lists knowledge bases for a location (paginated via limit/lastKnowledgeBaseId) — distinct from ghl_kb_faq_list, which lists FAQ entries inside one knowledge base. Get all knowledge bases for a location by location Id (paginated) Lists knowledge bases for a sub-account (location), with optional name search and cursor pagination. WHEN TO USE: use this when you need to see which knowledge bases exist; use getKnowledgeBaseById for one; use createKnowledgeBase to add one. RETURNS: a page of knowledge bases, activeCount, hasMore, and lastKnowledgeBaseId for the next page. Endpoint: GET /knowledge-bases/ (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly Pagination params: limit, lastKnowledgeBaseId — pass them to page through full result sets.

Inputs: locationId (required), limit, query, lastKnowledgeBaseId.

ghl_kb_update_knowledge_baseA
Idempotent

Update a knowledge base Updates the name and/or description of an existing knowledge base. WHEN TO USE: use this when you need to rename or re-describe a knowledge base; use createKnowledgeBase to add one; use deleteKnowledgeBase to remove one. RETURNS: whether the update succeeded. Endpoint: PUT /knowledge-bases/{id} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: id (required), body (required).

ghl_kb_upload_fileA

Uploads a file to knowledge base (max file size: 10MB) Uploads a PDF, DOC, or DOCX file (max 10MB) into a knowledge base for training. WHEN TO USE: use this when you need to add a document source; use getFilesByKnowledgeBasePublic to list uploads; use deleteFile to remove a file. Do not use this for website pages — use discoverWebsite / trainDiscoveredUrls. RETURNS: success and the uploaded file url, fileId, and folder path. Endpoint: POST /knowledge-bases/files (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

Inputs: body (required).

ghl_location_createA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Creates a new sub-account (location) under the given companyId. Create Sub-Account (Formerly Location)

Inputs: body (required).

ghl_location_create_custom_fieldC

Create Custom Field Endpoint: POST /locations/{locationId}/customFields (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/customFields.write

Inputs: body (required), locationId (required).

ghl_location_create_custom_valueB

Create Custom Value Endpoint: POST /locations/{locationId}/customValues (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/customValues.write

Inputs: body (required), locationId (required).

ghl_location_create_recurring_taskC

Create Recurring Task Endpoint: POST /locations/{locationId}/recurring-tasks (Version header: v3; source: v3/locations-v3.json)

Inputs: body (required), locationId (required).

ghl_location_create_tagB

Create Tag Create tag Endpoint: POST /locations/{locationId}/tags (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/tags.write

Inputs: body (required), locationId (required).

ghl_location_deleteA
DestructiveIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Irreversible: deletes the sub-account; deleteTwilioAccount query param controls whether the attached Twilio sub-account is also torn down. Delete Sub-Account (Formerly Location) Delete a Sub-Account (Formerly Location) from the Agency Endpoint: DELETE /locations/{locationId} (Version header: v3; source: v3/locations-v3.json) Requires an Agency (company-level) token. OAuth scopes: locations.internal-access-only

Inputs: locationId (required), deleteTwilioAccount (required).

ghl_location_delete_an_email_sms_templateB
DestructiveIdempotent

DELETE an email/sms template Endpoint: DELETE /locations/{locationId}/templates/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), locationId (required).

ghl_location_delete_custom_fieldC
DestructiveIdempotent

Delete Custom Field Endpoint: DELETE /locations/{locationId}/customFields/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), locationId (required).

ghl_location_delete_custom_valueC
DestructiveIdempotent

Delete Custom Value Endpoint: DELETE /locations/{locationId}/customValues/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), locationId (required).

ghl_location_delete_recurring_taskA
DestructiveIdempotent

Delete Recurring Task Endpoint: DELETE /locations/{locationId}/recurring-tasks/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), locationId (required).

ghl_location_delete_tagA
DestructiveIdempotent

Delete tag Endpoint: DELETE /locations/{locationId}/tags/{tagId} (Version header: v3; source: v3/locations-v3.json)

Inputs: tagId (required), locationId (required).

ghl_location_getA
Read-onlyIdempotent

Get Sub-Account (Formerly Location) Get details of a Sub-Account (Formerly Location) by passing the sub-account id Endpoint: GET /locations/{locationId} (Version header: v3; source: v3/locations-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: locations.readonly

Inputs: locationId (required).

ghl_location_get_all_or_email_sms_templatesB
Read-onlyIdempotent

GET all or email/sms templates Endpoint: GET /locations/{locationId}/templates (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/templates.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: originId (required), locationId (required), skip, type, +2 more.

ghl_location_get_conversation_channelA
Read-onlyIdempotent

Get Conversation Channel Get the conversation channel providers configured for a location by type (SMS or Email) Endpoint: GET /locations/{locationId}/conversationChannels/{type} (Version header: v3; source: v3/locations-v3.json) Requires a Sub-Account (location) token. OAuth scopes: locations.readonly

Inputs: type (required), locationId (required).

ghl_location_get_custom_fieldB
Read-onlyIdempotent

Get Custom Field Endpoint: GET /locations/{locationId}/customFields/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), locationId (required).

ghl_location_get_custom_fieldsB
Read-onlyIdempotent

Get Custom Fields Endpoint: GET /locations/{locationId}/customFields (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/customFields.readonly

Inputs: locationId (required), model.

ghl_location_get_custom_valueB
Read-onlyIdempotent

Get Custom Value Endpoint: GET /locations/{locationId}/customValues/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), locationId (required).

ghl_location_get_custom_valuesB
Read-onlyIdempotent

Get Custom Values Endpoint: GET /locations/{locationId}/customValues (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/customValues.readonly

Inputs: locationId (required).

ghl_location_get_permissionsA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only, despite the locations/write scope name. Get Permissions Get Sub-Account (Formerly Location) permissions Endpoint: GET /locations/{locationId}/permissions (Version header: v3; source: v3/locations-v3.json) Requires an Agency (company-level) token. OAuth scopes: locations/write

Inputs: locationId (required).

ghl_location_get_recurring_task_by_idB
Read-onlyIdempotent

Get Recurring Task By Id Endpoint: GET /locations/{locationId}/recurring-tasks/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), locationId (required).

ghl_location_get_tag_by_idB
Read-onlyIdempotent

Get tag by id Endpoint: GET /locations/{locationId}/tags/{tagId} (Version header: v3; source: v3/locations-v3.json)

Inputs: tagId (required), locationId (required).

ghl_location_get_tagsA
Read-onlyIdempotent

Get Tags Get Sub-Account (Formerly Location) Tags Endpoint: GET /locations/{locationId}/tags (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/tags.readonly

Inputs: locationId (required).

ghl_location_get_timezonesA
Read-onlyIdempotent

Fetch Timezones Fetch the available timezones Endpoint: GET /locations/{locationId}/timezones (Version header: v3; source: v3/locations-v3.json) Requires a Sub-Account (location) token. OAuth scopes: locations.readonly

Inputs: locationId (required).

ghl_location_updateA
Idempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Put Sub-Account (Formerly Location) Update a Sub-Account (Formerly Location) based on the data provided Endpoint: PUT /locations/{locationId} (Version header: v3; source: v3/locations-v3.json) Requires an Agency (company-level) token. OAuth scopes: locations.write

Inputs: body (required), locationId (required).

ghl_location_update_custom_fieldC
Idempotent

Update Custom Field Endpoint: PUT /locations/{locationId}/customFields/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), body (required), locationId (required).

ghl_location_update_custom_valueC
Idempotent

Update Custom Value Endpoint: PUT /locations/{locationId}/customValues/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), body (required), locationId (required).

ghl_location_update_permissionsA
Idempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Update Permissions Update Sub-Account (Formerly Location) permissions Endpoint: PUT /locations/{locationId}/permissions (Version header: v3; source: v3/locations-v3.json) Requires an Agency (company-level) token. OAuth scopes: locations/write

Inputs: body (required), locationId (required).

ghl_location_update_recurring_taskB
Idempotent

Update Recurring Task Endpoint: PUT /locations/{locationId}/recurring-tasks/{id} (Version header: v3; source: v3/locations-v3.json)

Inputs: id (required), body (required), locationId (required).

ghl_location_update_tagC
Idempotent

Update tag Endpoint: PUT /locations/{locationId}/tags/{tagId} (Version header: v3; source: v3/locations-v3.json)

Inputs: body (required), tagId (required), locationId (required).

ghl_location_upload_file_custom_fieldsA

File upload — body is multipart/form-data (the file plus its associated customField id/name), not JSON. The spec has no application/json alternative for this op. Uploads File to customFields Endpoint: POST /locations/{locationId}/customFields/upload (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/customFields.write

Inputs: body (required), locationId (required).

ghl_marketplace_chargeA

Create a new wallet charge Endpoint: POST /marketplace/billing/charges (Version header: v3; source: v3/marketplace-v3.json) Requires a Sub-Account (location) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: charges.write

Inputs: body (required).

ghl_marketplace_delete_chargeA
DestructiveIdempotent

Delete a wallet charge Endpoint: DELETE /marketplace/billing/charges/{chargeId} (Version header: v3; source: v3/marketplace-v3.json) Requires a Sub-Account (location) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: charges.write

Inputs: chargeId (required).

ghl_marketplace_get_chargesA
Read-onlyIdempotent

Get all wallet charges Endpoint: GET /marketplace/billing/charges (Version header: v3; source: v3/marketplace-v3.json) Requires a Sub-Account (location) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: charges.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: skip, limit, userId, endDate, +3 more.

ghl_marketplace_get_installer_detailsA
Read-onlyIdempotent

Get Installer Details Fetches installer details for the authenticated user. This endpoint returns information about the company, location, user, and installation details associated with the current OAuth token. Endpoint: GET /marketplace/app/{appId}/installations (Version header: v3; source: v3/marketplace-v3.json) Requires an Agency or Sub-Account token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: marketplace-installer-details.readonly

Inputs: appId (required).

ghl_marketplace_get_rebilling_configA
Read-onlyIdempotent

Get rebilling config for an app subscription and usage plans Get rebilling config for an app subscription and usage plans for the authenticated sub-account. This endpoint returns the subscription and usage plans for an app. Endpoint: GET /marketplace/app/{appId}/rebilling-config/location/{locationId} (Version header: v3; source: v3/marketplace-v3.json) Requires a Sub-Account (location) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.readonly

Inputs: appId (required), locationId (required).

ghl_marketplace_get_specific_chargeA
Read-onlyIdempotent

Get specific wallet charge details Endpoint: GET /marketplace/billing/charges/{chargeId} (Version header: v3; source: v3/marketplace-v3.json) Requires a Sub-Account (location) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: charges.readonly

Inputs: chargeId (required).

ghl_marketplace_has_fundsA
Read-onlyIdempotent

Check if account has sufficient funds Endpoint: GET /marketplace/billing/charges/has-funds (Version header: v3; source: v3/marketplace-v3.json) Requires a Sub-Account (location) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: charges.readonly

Inputs: no named parameters.

ghl_marketplace_migrate_connectionA

Migrate external authentication connection Migrates an external authentication connection credentials (basic or oauth2) for a specific app and location. This endpoint validates the app configuration, stores credentials safely in CRM's native encrypted storage. With this the lifecycle of the token is managed by CRM. Endpoint: POST /marketplace/external-auth/migration (Version header: v3; source: v3/marketplace-v3.json) Requires a Sub-Account (location) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: marketplace-external-auth-migration.write

Inputs: body (required).

ghl_marketplace_uninstall_applicationA
DestructiveIdempotent

Uninstall an application Uninstalls an application from your company or a specific location. This will remove the application`s access and stop all its functionalities Endpoint: DELETE /marketplace/app/{appId}/installations (Version header: v3; source: v3/marketplace-v3.json) Requires an Agency or Sub-Account token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.write

Inputs: body (required), appId (required).

ghl_media_bulk_delete_filesA
Idempotent

Bulk Delete / Trash Files/Folders Soft-deletes or trashes multiple files and folders in a single request Endpoint: PUT /medias/delete-files (Version header: v3; source: v3/medias-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required).

ghl_media_bulk_update_filesA
Idempotent

Bulk Update Files/Folders Updates metadata or status of multiple files and folders Endpoint: PUT /medias/update-files (Version header: v3; source: v3/medias-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required).

ghl_media_create_folderB

Create Folder Creates a new folder in the media storage Endpoint: POST /medias/folder (Version header: v3; source: v3/medias-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required).

ghl_media_delete_fileA
DestructiveIdempotent

Delete File or Folder Deletes specific file or folder from the media storage Endpoint: DELETE /medias/{id} (Version header: v3; source: v3/medias-v3.json) Requires a Sub-Account (location) token. OAuth scopes: medias.write

Inputs: id (required), altId (required), altType (required).

ghl_media_list_filesA
Read-onlyIdempotent

Regression check (old connector 422'd here because it had no way to pass the required type param): VERIFIED FIXED — type, altType, altId, sortBy, sortOrder are all present and required in this tool's input schema, matching the spec. Get List of Files/Folders Fetches list of files and folders from the media storage Endpoint: GET /medias/files (Version header: v3; source: v3/medias-v3.json) Requires a Sub-Account (location) token. OAuth scopes: medias.readonly Pagination params: offset, limit — pass them to page through full result sets.

Inputs: type (required), altId (required), sortBy (required), altType (required), +6 more.

ghl_media_update_fileB

Update File/Folder Updates a single file or folder by ID Endpoint: POST /medias/{id} (Version header: v3; source: v3/medias-v3.json) Requires a Sub-Account (location) token.

Inputs: id (required), body (required).

ghl_media_upload_fileA

multipart/form-data upload. body.file (binary) is required UNLESS body.hosted is true, in which case body.fileUrl is required instead. For local files, pass body.file as { filePath, filename?, mimeType? } — http.ts reads the file from disk and builds a real multipart payload (schema relaxed to allow this 2026-07-16; the earlier note claiming no multipart construction was stale/wrong per http.ts). Max 25MB (images/docs) / 500MB (video). Upload File into Media Storage If hosted is set to true then fileUrl is required. Else file is required. If adding a file, maximum allowed is 25 MB. For video files, the maximum allowed size is 500 MB. Endpoint: POST /medias/upload-file (Version header: v3; source: v3/medias-v3.json) Requires a Sub-Account (location) token. OAuth scopes: medias.write

Inputs: body (required).

ghl_oauth_exchange_location_tokenA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Body is application/x-www-form-urlencoded per spec (companyId, locationId as form fields), not JSON. This is the standard way to mint a location-scoped token from an agency token. Get Location Access Token from Agency Token This API allows you to generate locationAccessToken from AgencyAccessToken Endpoint: POST /oauth/location-token (Version header: v3; source: v3/oauth-v3.json) Requires an Agency (company-level) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.write

Inputs: body (required).

ghl_oauth_get_access_tokenA

OAuth2 token exchange (authorization_code / refresh_token grants). Form-encoded body only: the live docs (2026-08-10, breaking) no longer accept application/json, and the body fields are snake_case (client_id, client_secret, grant_type, code, refresh_token, user_type, redirect_uri). No security scheme on this op (client credentials go in the body). Get Access Token Use Access Tokens to access CRM resources on behalf of an authenticated location/company. Endpoint: POST /oauth/token (Version header: v3; source: v3/oauth-v3.json)

Inputs: body (required).

ghl_oauth_get_installed_locationA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only, no Location-Access alternative. Legacy twin of GET /oauth/installed-locations (v3); prefer the v3 op for new integrations. [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Location where app is installed This API allows you fetch location where app is installed upon Endpoint: GET /oauth/installedLocations (Version header: 2021-07-28; source: oauth.json) Requires an Agency (company-level) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: appId (required), companyId (required), skip, limit, +6 more.

ghl_oauth_get_installed_locationsB
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only, no Location-Access alternative. Get Location where app is installed This API allows you fetch location where app is installed upon Endpoint: GET /oauth/installed-locations (Version header: v3; source: v3/oauth-v3.json) Requires an Agency (company-level) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.readonly Pagination params: pageSize — pass them to page through full result sets.

Inputs: appId (required), companyId (required), query, planId, +7 more.

ghl_oauth_get_location_access_tokenA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Body is application/x-www-form-urlencoded per spec (companyId, locationId as form fields), not JSON. Legacy twin of POST /oauth/location-token (v3); prefer the v3 op for new integrations. [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Location Access Token from Agency Token This API allows you to generate locationAccessToken from AgencyAccessToken Endpoint: POST /oauth/locationToken (Version header: 2021-07-28; source: oauth.json) Requires an Agency (company-level) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.write

Inputs: body (required).

ghl_object_create_custom_objectA

Creates a new custom object SCHEMA (not a record). Renamed from the auto-generated 'ghl_object_create_custom_schema' to match GHL's own terminology ('Create Custom Object') and avoid confusion with ghl_object_update_schema/ghl_object_get_schema_by_key which operate on already-created objects. Create Custom Object Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0 Endpoint: POST /objects/ (Version header: v3; source: v3/objects-v3.json) Requires an Agency (company-level) token. OAuth scopes: objects/schema.write

Inputs: body (required).

ghl_object_create_noteC

Create Note Endpoint: POST /notes/ (Version header: v3; source: v3/objects-v3.json) OAuth scopes: notes.write

Inputs: body (required), locationId (required).

ghl_object_create_recordA

SPEC GAP: CreateCustomObjectRecordDto is an empty object schema in v3/objects-v3.json — verified against the raw spec, not an extraction bug. The body property will accept arbitrary JSON; GHL's convention (per external docs linked from this op, not confirmed in this corpus) is a properties object keyed by the object's field keys. Create Record Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296 Endpoint: POST /objects/{schemaKey}/records (Version header: v3; source: v3/objects-v3.json) OAuth scopes: objects/record.write

Inputs: body (required), schemaKey (required).

ghl_object_delete_noteB
DestructiveIdempotent

Delete Note Endpoint: DELETE /notes/{id} (Version header: v3; source: v3/objects-v3.json) OAuth scopes: notes.write

Inputs: id (required), locationId (required).

ghl_object_delete_recordA
DestructiveIdempotent

Delete Record Delete Record By Id . Supported Objects are business and custom objects. Endpoint: DELETE /objects/{schemaKey}/records/{id} (Version header: v3; source: v3/objects-v3.json)

Inputs: id (required), schemaKey (required).

ghl_object_get_noteB
Read-onlyIdempotent

Get Note Endpoint: GET /notes/{id} (Version header: v3; source: v3/objects-v3.json) OAuth scopes: notes.readonly

Inputs: id (required), locationId (required).

ghl_object_get_record_by_idC
Read-onlyIdempotent

Get Record By Id Allows you to get a Standard Object like business and custom object record by Id Endpoint: GET /objects/{schemaKey}/records/{id} (Version header: v3; source: v3/objects-v3.json)

Inputs: id (required), schemaKey (required).

ghl_object_get_schema_by_keyA
Read-onlyIdempotent

Get Object Schema by key / id Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0 Endpoint: GET /objects/{key} (Version header: v3; source: v3/objects-v3.json) OAuth scopes: objects/schema.readonly

Inputs: key (required), locationId (required), fetchProperties.

ghl_object_listA
Read-onlyIdempotent

Lists all objects (standard: contact/opportunity/business, plus custom) for a location. Renamed from the auto-generated 'ghl_object_get_by_location_id' — that name was ambiguous against ghl_object_get_schema_by_key (GET /objects/{key}, single-object lookup) per the brief's list/get_by_id naming guidance. Get all objects for a location Get all objects for a location. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0 Endpoint: GET /objects/ (Version header: v3; source: v3/objects-v3.json) OAuth scopes: objects/schema.readonly

Inputs: locationId (required).

ghl_object_restore_noteC

Restore Note Endpoint: POST /notes/{id}/restore (Version header: v3; source: v3/objects-v3.json) OAuth scopes: notes.write

Inputs: id (required), body (required), locationId (required).

ghl_object_search_notesB
Read-onlyIdempotent

Search Notes Endpoint: POST /notes/search (Version header: v3; source: v3/objects-v3.json) OAuth scopes: notes.readonly

Inputs: body (required).

ghl_object_search_recordsB
Read-onlyIdempotent

Body (SearchRecordsBody) fully specified in the OpenAPI, unlike the sibling create/update record ops — locationId, page, pageLimit, query, and searchAfter are all present and required. Search Object Records Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336 Endpoint: POST /objects/{schemaKey}/records/search (Version header: v3; source: v3/objects-v3.json) OAuth scopes: objects/record.readonly

Inputs: body (required), schemaKey (required).

ghl_object_update_noteC
Idempotent

Update Note Endpoint: PUT /notes/{id} (Version header: v3; source: v3/objects-v3.json) OAuth scopes: notes.write

Inputs: id (required), body (required), locationId (required).

ghl_object_update_note_attachmentsB

Update Note Attachments Endpoint: PATCH /notes/{id}/attachments (Version header: v3; source: v3/objects-v3.json) OAuth scopes: notes.write

Inputs: id (required), body (required), locationId (required).

ghl_object_update_note_relationsC
Idempotent

Update Note Relations Endpoint: PUT /notes/{id}/relations (Version header: v3; source: v3/objects-v3.json) OAuth scopes: notes.write

Inputs: id (required), body (required), locationId (required).

ghl_object_update_recordA
Idempotent

SPEC GAP: UpdateCustomObjectRecordDto is an empty object schema in v3/objects-v3.json — verified against the raw spec, not an extraction bug. The body property will accept arbitrary JSON; GHL's convention (per external docs linked from this op, not confirmed in this corpus) is a properties object keyed by the object's field keys. Update Record Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296 Endpoint: PUT /objects/{schemaKey}/records/{id} (Version header: v3; source: v3/objects-v3.json)

Inputs: id (required), body (required), schemaKey (required), locationId (required).

ghl_object_update_schemaA
Idempotent

Renamed from the auto-generated 'ghl_object_update_custom' for clarity and to pair with ghl_object_get_schema_by_key. Update Object Schema By Key / Id Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0 Endpoint: PUT /objects/{key} (Version header: v3; source: v3/objects-v3.json) OAuth scopes: objects/schema.write

Inputs: key (required), body (required).

ghl_opportunity_add_followersB

Add Followers Endpoint: POST /opportunities/{id}/followers (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.write

Inputs: id (required), body (required).

ghl_opportunity_createB

Create Opportunity Endpoint: POST /opportunities/ (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.write

Inputs: body (required).

ghl_opportunity_create_pipelineA

Create Pipeline Creates a new pipeline with at least one stage for a given location. Pipeline names must be unique per location (case-insensitive), and stage names must be unique within the pipeline. To enable manual win probability, set useOpportunityProbability to true and provide a stageWinProbability (0–100) on every stage — if any stage is missing a value, the system falls back to auto-computed probabilities based on stage position. Endpoint: POST /opportunities/pipelines (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: pipelines.create

Inputs: body (required).

ghl_opportunity_deleteA
DestructiveIdempotent

Delete Opportunity Endpoint: DELETE /opportunities/{id} (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.write

Inputs: id (required).

ghl_opportunity_delete_pipelineA
DestructiveIdempotent

Delete Pipeline Permanently deletes a pipeline and all opportunities within it. This action is irreversible — all opportunities across every stage of this pipeline will be removed. Ensure you have migrated or exported any opportunities before calling this endpoint. Endpoint: DELETE /opportunities/pipelines/{pipelineId} (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: pipelines.write

Inputs: pipelineId (required).

ghl_opportunity_getA
Read-onlyIdempotent

Get Opportunity Endpoint: GET /opportunities/{id} (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.readonly

Inputs: id (required).

ghl_opportunity_get_lost_reasonB
Read-onlyIdempotent

Get lost reason Endpoint: GET /opportunities/lost-reason (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), name, skip, limit, +3 more.

ghl_opportunity_get_pipelineA
Read-onlyIdempotent

Get Pipeline Retrieves a single pipeline by its ID, including all its stages and configuration. Endpoint: GET /opportunities/pipelines/{pipelineId} (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: pipelines.readonly

Inputs: pipelineId (required).

ghl_opportunity_remove_followersA
DestructiveIdempotent

Remove Followers Allows removal of one or all followers from an opportunity. Endpoint: DELETE /opportunities/{id}/followers (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.write

Inputs: id (required), body (required), isRemoveAllFollowers.

ghl_opportunity_search_advancedA
Read-onlyIdempotent

Advanced filter-combination search (POST body: locationId, query, limit, page, searchAfter, additionalDetails). Distinct from ghl_opportunity_search (GET /opportunities/search), which covers simple field-filter + cursor/page pagination. See docs/audits/opportunities.md for full pagination guidance (meta.nextPageUrl / startAfter+startAfterId vs page-based). Search Opportunities Search Opportunities based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f Endpoint: POST /opportunities/search (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.readonly

Inputs: body (required).

ghl_opportunity_updateA
Idempotent

Body accepts pipelineId, name, pipelineStageId, status, monetaryValue, forecastExpectedCloseDate, forecastProbability, assignedTo, and customFields (id-or-key + string/array/object fieldValue variants) — all verified present against UpdateOpportunityDtoV3. Update Opportunity Endpoint: PUT /opportunities/{id} (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.write

Inputs: id (required), body (required).

ghl_opportunity_update_pipelineA
Idempotent

Update Pipeline Updates an existing pipeline. The stages array is a full replacement — include the id field on existing stages to retain them, or omit it to create a new stage. You cannot remove all stages at once. Any opportunities in removed stages are automatically migrated to the lowest-position remaining stage. Pipeline and stage names must remain unique (case-insensitive) within the location. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-709536/75a21483123abd7 Endpoint: PUT /opportunities/pipelines/{pipelineId} (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: pipelines.write

Inputs: body (required), pipelineId (required).

ghl_opportunity_update_statusB
Idempotent

Update Opportunity Status Endpoint: PUT /opportunities/{id}/status (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.write

Inputs: id (required), body (required).

ghl_opportunity_upsertC

Upsert Opportunity Endpoint: POST /opportunities/upsert (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.write

Inputs: body (required).

ghl_payment_coupon_createA

Create Coupon The "Create Coupon" API allows you to create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, and applicable products. Use this endpoint to set up promotional offers and special discounts for your customers. Endpoint: POST /payments/coupon (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.write

Inputs: body (required).

ghl_payment_coupon_deleteA
DestructiveIdempotent

Permanently deletes the coupon. Any checkout links relying on its code will stop applying the discount. Delete Coupon The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note that this action cannot be undone. Endpoint: DELETE /payments/coupon (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.write

Inputs: body (required).

ghl_payment_coupon_getA
Read-onlyIdempotent

Fetch Coupon The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon parameters, usage statistics, validity periods, and other promotional details. Endpoint: GET /payments/coupon (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.readonly

Inputs: id (required), code (required), altId (required), altType (required).

ghl_payment_coupon_listA
Read-onlyIdempotent

List Coupons The "List Coupons" API allows you to retrieve a list of all coupons available in your location. Use this endpoint to view all promotional offers and special discounts for your customers. Endpoint: GET /payments/coupon/list (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), limit, offset, +2 more.

ghl_payment_coupon_updateA
Idempotent

Update Coupon The "Update Coupon" API enables you to modify existing coupon details such as discount values, validity periods, usage limits, and other promotional parameters. Use this endpoint to adjust or extend promotional offers for your customers. Endpoint: PUT /payments/coupon (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.write

Inputs: body (required).

ghl_payment_custom_provider_createA

Create new integration API to create a new association for an app and location Endpoint: POST /payments/custom-provider/provider (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/custom-provider.write

Inputs: body (required), locationId (required).

ghl_payment_custom_provider_create_configB

Create new provider config API to create a new payment config for given location Endpoint: POST /payments/custom-provider/connect (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/custom-provider.write

Inputs: body (required), locationId (required).

ghl_payment_custom_provider_deleteA
DestructiveIdempotent

Permanently removes the custom payment provider integration itself (not just its config). Any in-flight or future payment flows depending on it will fail. Deleting an existing integration API to delete an association for an app and location Endpoint: DELETE /payments/custom-provider/provider (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/custom-provider.write

Inputs: locationId (required).

ghl_payment_custom_provider_disconnect_configA

Disconnects the custom payment provider's live/test config. This can interrupt live payment collection at this location until reconnected. Disconnect existing provider config API to disconnect an existing payment config for given location Endpoint: POST /payments/custom-provider/disconnect (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/custom-provider.write

Inputs: body (required), locationId (required).

ghl_payment_custom_provider_get_configA
Read-onlyIdempotent

Fetch given provider config API for fetching an existing payment config for given location Endpoint: GET /payments/custom-provider/connect (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/custom-provider.readonly

Inputs: locationId (required).

ghl_payment_custom_provider_update_capabilitiesA
Idempotent

Custom-provider marketplace app update capabilities Toggle capabilities for the marketplace app tied to the OAuth client Endpoint: PUT /payments/custom-provider/capabilities (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/custom-provider.write

Inputs: body (required).

ghl_payment_integration_provider_createA

Create White-label Integration Provider The "Create White-label Integration Provider" API allows adding a new payment provider integration to the system which is built on top of Authorize.net or NMI. Use this endpoint to create a integration provider with the specified details. Ensure that the required information is provided in the request payload. This endpoint can be only invoked using marketplace-app token Endpoint: POST /payments/integrations/provider/whitelabel (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/integration.write

Inputs: body (required).

ghl_payment_integration_provider_listA
Read-onlyIdempotent

List White-label Integration Providers The "List White-label Integration Providers" API allows to retrieve a paginated list of integration providers. Customize your results by filtering whitelabel integration providers(which are built directly on top of Authorize.net or NMI) based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve integration provider information. Endpoint: GET /payments/integrations/provider/whitelabel (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/integration.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), limit, offset.

ghl_payment_order_create_fulfillmentB

Create order fulfillment The "Order Fulfillment" API facilitates the process of fulfilling an order. Endpoint: POST /payments/orders/{orderId}/fulfillments (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.write

Inputs: body (required), orderId (required).

ghl_payment_order_getA
Read-onlyIdempotent

Get Order by ID The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single order based on the provided order ID. Endpoint: GET /payments/orders/{orderId} (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.readonly

Inputs: altId (required), orderId (required), locationId.

ghl_payment_order_listA
Read-onlyIdempotent

List Orders The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information. Endpoint: GET /payments/orders (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), endAt, limit, offset, +9 more.

ghl_payment_order_list_fulfillmentsA
Read-onlyIdempotent

List fulfillment List all fulfillment history of an order Endpoint: GET /payments/orders/{orderId}/fulfillments (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.readonly

Inputs: altId (required), altType (required), orderId (required).

ghl_payment_order_list_notesB
Read-onlyIdempotent

List Order Notes List all notes of an order Endpoint: GET /payments/orders/{orderId}/notes (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required), orderId (required).

ghl_payment_order_record_paymentA

Records a manual/offline payment against an order. Does not process a live charge. Record Order Payment The "Record Order Payment" API allows to record a payment for an order. Use this endpoint to record payment for an order and update the order status to "Paid". Endpoint: POST /payments/orders/{orderId}/record-payment (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.collectPayment

Inputs: body (required), orderId (required).

ghl_payment_subscription_getA
Read-onlyIdempotent

Get Subscription by ID The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details for a single subscription based on the provided subscription ID. Endpoint: GET /payments/subscriptions/{subscriptionId} (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/subscriptions.readonly

Inputs: altId (required), altType (required), subscriptionId (required).

ghl_payment_subscription_listA
Read-onlyIdempotent

List Subscriptions The "List Subscriptions" API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type, subscription status, payment mode, date range, type of source, contact, subscription id, entity id, contact or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve subscription information. Endpoint: GET /payments/subscriptions (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/subscriptions.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), id, endAt, +9 more.

ghl_payment_transaction_getA
Read-onlyIdempotent

Get Transaction by ID The "Get Transaction by ID" API allows to retrieve information for a specific transaction using its unique identifier. Use this endpoint to fetch details for a single transaction based on the provided transaction ID. Endpoint: GET /payments/transactions/{transactionId} (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/transactions.readonly

Inputs: altId (required), altType (required), transactionId (required), locationId.

ghl_payment_transaction_listA
Read-onlyIdempotent

List Transactions The "List Transactions" API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, transaction status, payment mode, date range, type of source, contact, subscription id, entity id or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve transaction information. Endpoint: GET /payments/transactions (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/transactions.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), endAt, limit, +10 more.

ghl_phone_list_active_numbersB
Read-onlyIdempotent

List active numbers List active numbers. With version: v3, the HTTP 200 body is the standard success envelope (status, data, message, statusCode). The v3 list payload is under data; isUnderGhl is renamed to isUnderLc per AIP naming convention. Endpoint: GET /phone-system/numbers/location/{locationId} (Version header: v3; source: v3/phone-system-v3.json) Requires a Sub-Account (location) token. OAuth scopes: phonenumbers.read Pagination params: pageSize, page — pass them to page through full result sets.

Inputs: locationId (required), page, pageSize, searchFilter, +2 more.

ghl_phone_list_available_numbersA
Read-onlyIdempotent

Renamed — the auto-generated name carried a spec typo ('acountry'). Spec also declares no Version header for this endpoint (verified, not an extraction gap). List available phone numbers Search Twilio inventory for purchasable phone numbers in a country for the given location. Endpoint: GET /phone-system/numbers/location/{locationId}/available (Version header: v3; source: v3/phone-system-v3.json) Requires a Sub-Account (location) token. OAuth scopes: phonenumbers.read

Inputs: anywhere (required), lastPart (required), firstPart (required), locationId (required), +5 more.

ghl_phone_list_number_poolsA
Read-onlyIdempotent

Spec declares no Version header for this endpoint (verified against the official spec, not an extraction gap) — the tool omits it accordingly. List number pools Returns number pools for the location. Requires locationId as a query parameter. Endpoint: GET /phone-system/number-pools (Version header: v3; source: v3/phone-system-v3.json) Requires a Sub-Account (location) token. OAuth scopes: numberpools.read

Inputs: locationId (required).

ghl_phone_purchase_numberA

Purchase number for location Purchase number for location. With version: v3, the HTTP 201 body is the standard success envelope (status, data, message, statusCode). The v3 purchase fields live under data: number, locationId, id, and underLcAccount (renamed from under_ghl_account). Endpoint: POST /phone-system/numbers/location/{locationId}/purchase (Version header: v3; source: v3/phone-system-v3.json) Requires a Sub-Account (location) token. OAuth scopes: phonenumbers.write

Inputs: body (required), locationId (required).

ghl_pipeline_listA
Read-onlyIdempotent

Lists pipelines (and their stages) for a location. Named as its own pipeline_* tool per house convention even though it lives under the /opportunities path in the spec. Get Pipelines Endpoint: GET /opportunities/pipelines (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.readonly

Inputs: locationId (required).

ghl_product_bulk_editB

Bulk-edits fields across multiple products and their prices in one call — review the target scope carefully before sending. Bulk Edit Products and Prices API to bulk edit products and their associated prices (max 30 entities) Endpoint: POST /products/bulk-update/edit (Version header: v3; source: v3/products-v3.json)

Inputs: body (required).

ghl_product_bulk_updateB

Bulk-mutates multiple products in one call — review the target productIds carefully before sending. Bulk Update Products API to bulk update products (price, availability, collections, delete) Endpoint: POST /products/bulk-update (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.write

Inputs: body (required).

ghl_product_collection_createA

Create Product Collection Create a new Product Collection for a specific location Endpoint: POST /products/collections (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products/collection.write

Inputs: body (required).

ghl_product_collection_deleteA
DestructiveIdempotent

Delete Product Collection Delete specific product collection with Id :collectionId Endpoint: DELETE /products/collections/{collectionId} (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products/collection.write

Inputs: altId (required), altType (required), collectionId (required).

ghl_product_collection_getA
Read-onlyIdempotent

Get Details about individual product collection Endpoint: GET /products/collections/{collectionId} (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products/collection.readonly

Inputs: altId (required), collectionId (required).

ghl_product_collection_listA
Read-onlyIdempotent

Fetch Product Collections Internal API to fetch the Product Collections Endpoint: GET /products/collections (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products/collection.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), name, limit, +2 more.

ghl_product_collection_updateB
Idempotent

Update Product Collection Update a specific product collection with Id :collectionId Endpoint: PUT /products/collections/{collectionId} (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products/collection.write

Inputs: body (required), collectionId (required).

ghl_product_createB

Create Product The "Create Product" API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request payload. Endpoint: POST /products/ (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products.write

Inputs: body (required).

ghl_product_deleteA
DestructiveIdempotent

Delete Product by ID The "Delete Product by ID" API allows deleting a specific product using its unique identifier. Use this endpoint to remove a product from the system. Endpoint: DELETE /products/{productId} (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products.write

Inputs: productId (required), locationId (required), sendWishlistStatus.

ghl_product_getA
Read-onlyIdempotent

Get Product by ID The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a single product based on the provided product ID. Endpoint: GET /products/{productId} (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products.readonly

Inputs: productId (required), locationId (required), sendWishlistStatus.

ghl_product_inventory_listA
Read-onlyIdempotent

List Inventory The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters. Endpoint: GET /products/inventory (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), limit, offset, +1 more.

ghl_product_inventory_updateA

Update Inventory The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in the inventory. Endpoint: POST /products/inventory (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.write

Inputs: body (required).

ghl_product_listA
Read-onlyIdempotent

Lists products for a location. (Generated tool name was originally 'ghl_product_list_invoices' — an evident copy-paste artifact unrelated to this operation; corrected here.) List Products The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information. Endpoint: GET /products/ (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: locationId (required), limit, expand, offset, +8 more.

ghl_product_price_createA

Create Price for a Product The "Create Price for a Product" API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the specified details for a particular product. Ensure that the required information is provided in the request payload. Endpoint: POST /products/{productId}/price (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.write

Inputs: body (required), productId (required).

ghl_product_price_deleteA
DestructiveIdempotent

Delete Price by ID for a Product The "Delete Price by ID for a Product" API allows deleting a specific price associated with a particular product using its unique identifier. Use this endpoint to remove a price from the system. Endpoint: DELETE /products/{productId}/price/{priceId} (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.write

Inputs: priceId (required), productId (required), locationId (required).

ghl_product_price_getA
Read-onlyIdempotent

Get Price by ID for a Product The "Get Price by ID for a Product" API allows retrieving information for a specific price associated with a particular product using its unique identifier. Use this endpoint to fetch details for a single price based on the provided price ID and product ID. Endpoint: GET /products/{productId}/price/{priceId} (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.readonly

Inputs: priceId (required), productId (required), locationId (required).

ghl_product_price_listA
Read-onlyIdempotent

List Prices for a Product The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product. Customize your results by filtering prices or paginate through the list using the provided query parameters. Endpoint: GET /products/{productId}/price (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: productId (required), locationId (required), ids, limit, +1 more.

ghl_product_price_updateA
Idempotent

Update Price by ID for a Product The "Update Price by ID for a Product" API allows modifying information for a specific price associated with a particular product using its unique identifier. Use this endpoint to update details for a single price based on the provided price ID and product ID. Endpoint: PUT /products/{productId}/price/{priceId} (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.write

Inputs: body (required), priceId (required), productId (required).

ghl_product_review_bulk_updateA

Bulk-mutates multiple reviews in one call (e.g. approve/reject in batch) — review the target reviewIds carefully before sending. Update Product Reviews Update one or multiple product reviews: status, reply, etc. Endpoint: POST /products/reviews/bulk-update (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.write

Inputs: body (required).

ghl_product_review_countA
Read-onlyIdempotent

Fetch Review Count as per status API to fetch the Review Count as per status Endpoint: GET /products/reviews/count (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.readonly

Inputs: altId (required), altType (required), rating, endDate, +3 more.

ghl_product_review_deleteA
DestructiveIdempotent

Delete Product Review Delete specific product review Endpoint: DELETE /products/reviews/{reviewId} (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.write

Inputs: altId (required), altType (required), reviewId (required), productId (required).

ghl_product_review_listA
Read-onlyIdempotent

Fetch Product Reviews API to fetch the Product Reviews Endpoint: GET /products/reviews (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.readonly Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), limit, offset, +7 more.

ghl_product_review_updateA
Idempotent

Update Product Reviews Update status, reply, etc of a particular review Endpoint: PUT /products/reviews/{reviewId} (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.write

Inputs: body (required), reviewId (required).

ghl_product_store_get_statsA
Read-onlyIdempotent

Fetch Product Store Stats API to fetch the total number of products, included in the store, and excluded from the store and other stats Endpoint: GET /products/store/{storeId}/stats (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.readonly

Inputs: altId (required), altType (required), storeId (required), search, +1 more.

ghl_product_store_set_inclusionA

Includes or excludes a product from the given store's storefront listing. Action to include/exclude the product in store API to update the status of products in a particular store Endpoint: POST /products/store/{storeId} (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.write

Inputs: body (required), storeId (required).

ghl_product_store_set_priorityB

Update product display priorities in store API to set the display priority of products in a store Endpoint: POST /products/store/{storeId}/priority (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required), storeId (required).

ghl_product_updateA
Idempotent

Update Product by ID The "Update Product by ID" API allows modifying information for a specific product using its unique identifier. Use this endpoint to update details for a single product based on the provided product ID. Endpoint: PUT /products/{productId} (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products.write

Inputs: body (required), productId (required).

ghl_project_add_list_taskA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Add A Task To An Additional List Adds an existing task to this list as an additional (non-home) membership. POST is not idempotent — adding a task that is already on the list conflicts. Response: { "success": true }. This path does not delete the task. Delete the task with DELETE /projects/tasks/{taskId}. Use Move Task to change the home list. Endpoint: POST /projects/lists/{listId}/tasks/{taskId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.write

Inputs: listId (required), taskId (required), locationId.

ghl_project_batch_tasksA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Fetch Tasks By IDs Fetches multiple tasks by id in one call. Results are RBAC-filtered — inaccessible ids are omitted rather than erroring. Does not return embedded subtasks. Endpoint: POST /projects/tasks/batch (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.readonly

Inputs: body (required), locationId.

ghl_project_create_folder_listA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Create List In Folder Creates a list inside a folder so tasks can be organized under that folder. Endpoint: POST /projects/folders/{folderId}/lists (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: body (required), folderId (required), locationId.

ghl_project_create_list_taskA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Create Task Creates a task in this list as its home list. title and dueDate are required. dueDate accepts ISO 8601 or a Unix timestamp string; responses return ISO 8601. Optional TipTap body — see TipTap documentation. To create a subtask, set parentTaskId. Response is { "task": { … } } without embedded subtasks. Endpoint: POST /projects/lists/{listId}/tasks (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.write

Inputs: body (required), listId (required), locationId.

ghl_project_create_recurring_taskA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Create Recurring Task Creates one recurring task definition. There is no list endpoint and no list binding. The schedule uses rruleOptions (intervalType, not a raw RRULE string). owners and contactIds are the recurring fields — task create uses assignees and contactId. Requires projects/tasks.recurring.write. Endpoint: POST /projects/recurring-tasks (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.recurring.write

Inputs: body (required), locationId.

ghl_project_create_spaceB

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Create Space Creates a top-level space (optional privacy + userIds when private). A default list is seeded server-side but is not returned on the public response. Endpoint: POST /projects/spaces (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: body (required), locationId.

ghl_project_create_space_folderB

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Create Folder Creates a folder inside a space. Folders group lists; a default list is seeded server-side but omitted from the public response. Endpoint: POST /projects/spaces/{spaceId}/folders (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: body (required), spaceId (required), locationId.

ghl_project_create_space_listA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Create List In Space Creates a list directly under a space. Prefer Create List In Folder when the list should live inside a folder. Endpoint: POST /projects/spaces/{spaceId}/lists (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: body (required), spaceId (required), locationId.

ghl_project_create_task_commentA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Create Comment Creates a top-level comment or a one-level reply (parentCommentId). Field is TipTap body — see TipTap documentation. Sanitised to a published allowlist before storage. Response: { "comment": { … } }. Endpoint: POST /projects/tasks/{taskId}/comments (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.comments.write

Inputs: body (required), taskId (required), locationId.

ghl_project_delete_folderA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Delete Folder Deletes a folder and its nested lists. Response: { "success": true } (no id). Endpoint: DELETE /projects/folders/{folderId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: folderId (required), locationId.

ghl_project_delete_folder_userA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Revoke Folder Member Revokes a direct user grant on the folder. Idempotent if the grant is already absent. Does not change isPrivate. Inherited access from ancestors is unchanged. Endpoint: DELETE /projects/folders/{folderId}/users/{userId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: userId (required), folderId (required), locationId.

ghl_project_delete_listA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Delete List Deletes a list. Response: { "success": true } (no id). Tasks that used it as home list follow product delete rules. Endpoint: DELETE /projects/lists/{listId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: listId (required), locationId.

ghl_project_delete_list_userA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Revoke List Member Revokes a direct user grant on the list. Idempotent if the grant is already absent. Does not change isPrivate. Inherited access from ancestors is unchanged. Endpoint: DELETE /projects/lists/{listId}/users/{userId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: listId (required), userId (required), locationId.

ghl_project_delete_recurring_taskA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Delete Recurring Task Deletes a recurring task definition so future occurrences stop being created. Endpoint: DELETE /projects/recurring-tasks/{id} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.recurring.write

Inputs: id (required), locationId.

ghl_project_delete_spaceB
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Delete Space Deletes a space. Response: { "success": true } (no id). Nested folders, lists, and related data follow the product delete rules for that space. Endpoint: DELETE /projects/spaces/{spaceId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: spaceId (required), locationId.

ghl_project_delete_space_userA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Revoke Space Member Revokes a direct user grant on the space. Idempotent if the grant is already absent. Does not change isPrivate. Inherited access from ancestors is unchanged. Endpoint: DELETE /projects/spaces/{spaceId}/users/{userId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: userId (required), spaceId (required), locationId.

ghl_project_delete_taskA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Delete A Task Or Subtask Deletes a task or subtask by id. Response: { "success": true, "id": "<taskId>" }. A second delete on the same id returns not found. Endpoint: DELETE /projects/tasks/{taskId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.write

Inputs: taskId (required), locationId.

ghl_project_delete_task_commentA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Delete A Comment Deletes a comment. Deleted comments do not appear in Get Task Comments. Response: { "success": true } (no id). 403 unless the caller is the comment author. Endpoint: DELETE /projects/tasks/{taskId}/comments/{commentId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.comments.write

Inputs: taskId (required), commentId (required), locationId.

ghl_project_get_folderB
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Folder Fetches one folder by id. Endpoint: GET /projects/folders/{folderId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly

Inputs: folderId (required), locationId.

ghl_project_get_folder_listsB
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Lists In Folder Pages lists under a folder (lists[], not items). Same paging as space children. Example: open a folder view, then Create List In Folder for a client project. Endpoint: GET /projects/folders/{folderId}/lists (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly Pagination params: limit, cursor — pass them to page through full result sets.

Inputs: folderId (required), limit, cursor, anchorId.

ghl_project_get_folder_usersA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Users With Folder Access Lists users with access to the folder as one unified users page (source: direct | inherited). skip / limit / total apply to the combined list. No PII and no query filter. Revoke with DELETE /projects/folders/{folderId}/users/{userId}. Endpoint: GET /projects/folders/{folderId}/users (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: folderId (required), skip, limit, locationId.

ghl_project_get_listB
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get List Fetches one list by id. parentId is the parent folder or space. Statuses: GET /projects/lists/{listId}/statuses. Endpoint: GET /projects/lists/{listId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly

Inputs: listId (required), locationId.

ghl_project_get_list_statusesA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get List Statuses Returns the effective status groups for a list — the same set as the owning space, resolved server-side. Prefer this over walking parentId up to the space. Endpoint: GET /projects/lists/{listId}/statuses (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly

Inputs: listId (required), locationId.

ghl_project_get_list_usersA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Users With List Access Lists users with access to the list as one unified users page (source: direct | inherited). skip / limit / total apply to the combined list. No PII and no query filter. Revoke with DELETE /projects/lists/{listId}/users/{userId}. Endpoint: GET /projects/lists/{listId}/users (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: listId (required), skip, limit, locationId.

ghl_project_get_recurring_taskB
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Recurring Task By Id Fetches one recurring task definition by id. Endpoint: GET /projects/recurring-tasks/{id} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.recurring.readonly

Inputs: id (required), locationId.

ghl_project_get_spaceA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Space Fetches one space by id, including name, privacy, and color. Endpoint: GET /projects/spaces/{spaceId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly

Inputs: spaceId (required), locationId.

ghl_project_get_space_foldersB
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Folders Pages folders under a space (folders[], not items). Simple: ?limit=20 then ?limit=20&cursor={nextCursor}. Deep-link: add anchorId of a known folder to load a window centered on it. Location comes from the token. Endpoint: GET /projects/spaces/{spaceId}/folders (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly Pagination params: limit, cursor — pass them to page through full result sets.

Inputs: spaceId (required), limit, cursor, anchorId.

ghl_project_get_space_listsA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Lists In Space Pages lists directly under a space (lists[], not items; excludes lists inside folders). Same limit/cursor paging as folders; optional anchorId for centered windows. Location comes from the token. Endpoint: GET /projects/spaces/{spaceId}/lists (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly Pagination params: limit, cursor — pass them to page through full result sets.

Inputs: spaceId (required), limit, cursor, anchorId.

ghl_project_get_spacesB
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get All Spaces Returns the location workspace (id, name) and every space the token can access. Marketplace example: bootstrap a Projects UI by listing spaces, then create a folder/list under one space. Endpoint: GET /projects/spaces (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly

Inputs: locationId.

ghl_project_get_space_statusesA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Space Statuses Returns effective status groups for the space (groups[].statuses[] with key, label, color, position). Use when rendering a board or mapping task status values. A task is complete when properties.statusGroup is done. Endpoint: GET /projects/spaces/{spaceId}/statuses (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly

Inputs: spaceId (required), locationId.

ghl_project_get_space_usersA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Users With Space Access Lists users with access as one unified users page (source: direct | inherited). skip / limit / total apply to the combined list (direct first). No name/email/photo and no query filter. Revoke a direct grant with DELETE /projects/spaces/{spaceId}/users/{userId}. PATCH userIds only adds grants. Endpoint: GET /projects/spaces/{spaceId}/users (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: spaceId (required), skip, limit, locationId.

ghl_project_get_taskA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get A Task By ID Fetches one task or subtask by id. Fields are returned under task. A subtask’s parent id is task.properties.parentTaskId. TipTap content is task.properties.body. properties.statusGroup is server-derived and read-only; a task is complete when it is done. The home list is properties.primaryListId. Embedded subtasks are not returned — use Search Tasks with subtaskViewMode=expanded. Endpoint: GET /projects/tasks/{taskId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.readonly

Inputs: taskId (required), locationId.

ghl_project_get_task_listsA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Lists For A Task Returns every list the task belongs to. The home list is the one with isHome: true (same id as properties.primaryListId). Other rows are additional lists. Move Task (PUT .../home-list) changes the home list. Endpoint: GET /projects/tasks/{taskId}/lists (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.readonly

Inputs: taskId (required), locationId.

ghl_project_list_list_tasksA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Tasks Pages tasks whose primary (home) list is this list. Use limit and query searchAfter from the previous response searchAfter (opaque base64url string). Prefer Search Tasks with parentTaskId / subtaskViewMode for subtask-focused views. Endpoint: GET /projects/lists/{listId}/tasks (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: listId (required), limit, locationId, searchAfter.

ghl_project_list_task_commentsA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Get Task Comments Pages comments on a task. Deleted comments are omitted. Replies are returned as sibling rows in comments with parentCommentId set — there is no nested replies array. skip must be a multiple of limit. total counts top-level comments only. Endpoint: GET /projects/tasks/{taskId}/comments (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.comments.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: taskId (required), skip, limit, locationId.

ghl_project_remove_list_taskA
DestructiveIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Remove A Task From Additional List Removes an additional-list membership. Response: { "success": true }. Cannot remove the task’s home list — move the home list first. This does not delete the task. Endpoint: DELETE /projects/lists/{listId}/tasks/{taskId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.write

Inputs: listId (required), taskId (required), locationId.

ghl_project_search_tasksA
Read-onlyIdempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Search Tasks Searches tasks across the location with filters, sort, free-text query, and optional subtaskViewMode. Requires limit; pass body searchAfter from the previous response searchAfter (opaque base64url string) for the next page. Scope to lists with listIds (max 10) — do not send a separate graph filter when using listIds. Filter subtasks with parentTaskId (Tasks V2 locations only; otherwise 422). subtaskViewMode=expanded returns embedded subtasks[]; separate may include parentName. Neither field appears on Get/Create/Update/List/Batch. total is the hit count after filters and access scope. Endpoint: POST /projects/tasks/search (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.readonly

Inputs: body (required), locationId.

ghl_project_set_task_home_listA
Idempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Move Task Moves the task’s home list to another list. Response: { "success": true }. 409 has two causes and one status: the task is already on the destination list (including as an additional list), or it is not on the current home list. If it is already an additional member of the destination, DELETE /projects/lists/{listId}/tasks/{taskId} on that list, then call Move Task. There is no separate error code for the two causes. Endpoint: PUT /projects/tasks/{taskId}/home-list (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.write

Inputs: body (required), taskId (required), locationId.

ghl_project_update_folderA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Update Folder Updates folder fields such as name, color, or privacy. color must be a palette swatch. userIds when making the folder private adds grants and does not revoke omitted users — use DELETE /projects/folders/{folderId}/users/{userId}. Setting isPrivate: false makes the folder public; existing direct grants remain but no longer gate access while public. Endpoint: PATCH /projects/folders/{folderId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: body (required), folderId (required), locationId.

ghl_project_update_listA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Update List Updates list fields such as name, color, or privacy. color must be a palette swatch. userIds when making the list private adds grants and does not revoke omitted users — use DELETE /projects/lists/{listId}/users/{userId}. Setting isPrivate: false makes the list public; existing direct grants remain but no longer gate access while public. Endpoint: PATCH /projects/lists/{listId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: body (required), listId (required), locationId.

ghl_project_update_recurring_taskA
Idempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Update Recurring Task Updates schedule or template fields on an existing recurring task definition. Endpoint: PUT /projects/recurring-tasks/{id} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.recurring.write

Inputs: id (required), body (required), locationId.

ghl_project_update_spaceA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Update Space Updates space fields such as name, color, or privacy. color must be one of the 16 palette swatches. When setting isPrivate: true, userIds is required and those users are granted access (add-only — omitting a user does not revoke). Revoke with DELETE /projects/spaces/{spaceId}/users/{userId}. Setting isPrivate: false makes the space public for the location; existing direct grants remain but no longer gate access while public. Endpoint: PATCH /projects/spaces/{spaceId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: body (required), spaceId (required), locationId.

ghl_project_update_taskA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Update A Task Or Subtask Updates a task or subtask by id (title, TipTap body, status, dates, assignees, priority, parentTaskId, custom fields, etc.). Response is { "task": { … } } without embedded subtasks. Endpoint: PATCH /projects/tasks/{taskId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.write

Inputs: body (required), taskId (required), locationId.

ghl_project_update_task_commentA

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Update A Comment Updates TipTap body and, when sent, mentionedUserIds — see TipTap documentation. 403 unless the caller is the comment author. Response: { "comment": { … } }. Endpoint: PATCH /projects/tasks/{taskId}/comments/{commentId} (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/tasks.comments.write

Inputs: body (required), taskId (required), commentId (required), locationId.

ghl_project_upsert_space_statusesB
Idempotent

PROJECT MANAGEMENT API — hierarchy is spaces -> folders -> lists -> tasks (+ comments, space statuses, recurring tasks). Task batch-get is RBAC-filtered (inaccessible ids are omitted, not errors) and omits embedded subtasks. position is an opaque server-assigned lexorank string; there is no public reorder endpoint. Recurring tasks use owners/contactIds and rruleOptions.intervalType (task create uses assignees/contactId). Task search supports updatedAt filtering/sorting for incremental sync. The docs do not describe what a delete cascades to — treat every delete as destructive. Update Statuses Replaces the whole space status set. Send every group you want to keep — omitted groups and statuses are removed. There is no If-Match and no per-status route. A task that still uses a removed status key keeps that key until you update the task. key is the stable id; label is display text. Status color is any hex. Space, folder, and list color must be one of the 16 palette swatches. A task is complete when properties.statusGroup is done. Endpoint: PUT /projects/spaces/{spaceId}/statuses (Version header: v3; source: v3/projects-v3.json) OAuth scopes: projects/workspace.write

Inputs: body (required), spaceId (required), locationId.

ghl_proposal_list_documentsA
Read-onlyIdempotent

List documents List documents for a location Endpoint: GET /proposals/document (Version header: v3; source: v3/proposals-v3.json) Requires an Agency or Sub-Account token. Pagination params: limit, skip — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, query, +4 more.

ghl_proposal_list_templatesA
Read-onlyIdempotent

List templates List document contract templates for a location Endpoint: GET /proposals/templates (Version header: v3; source: v3/proposals-v3.json) Requires an Agency or Sub-Account token. Pagination params: limit, skip — pass them to page through full result sets.

Inputs: locationId (required), name, skip, type, +5 more.

ghl_proposal_send_documentB

Send document Send document to a client Endpoint: POST /proposals/document/send (Version header: v3; source: v3/proposals-v3.json) Requires an Agency or Sub-Account token.

Inputs: body (required).

ghl_proposal_send_templateB

Send template Send template to a client Endpoint: POST /proposals/templates/send (Version header: v3; source: v3/proposals-v3.json) Requires an Agency or Sub-Account token.

Inputs: body (required).

ghl_saas_allow_attach_rebillingA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Allow Attach Rebilling Marks a SaaS sub-account as awaiting rebilling attach and optionally stores the rebilling configuration that should be applied when the rebilling config is created. Sets payment_pending on the sub-account. Only allowed when the sub-account is in setup_pending state. Endpoint: POST /saas/allow-attach-rebilling/{locationId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), locationId (required).

ghl_saas_bulk_disableA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Disable SaaS for locations Disable SaaS for locations for given locationIds Endpoint: POST /saas/bulk-disable-saas/{companyId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), companyId (required).

ghl_saas_bulk_disable_deprecatedA

DEPRECATED per spec — superseded by POST /saas/bulk-disable-saas/{companyId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Disable SaaS for locations Disable SaaS for locations for given locationIds Endpoint: POST /saas-api/public-api/bulk-disable-saas/{companyId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: body (required), companyId (required).

ghl_saas_bulk_enableA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Bulk Enable SaaS Enable SaaS mode for multiple locations with support for both SaaS v1 and v2 Endpoint: POST /saas/bulk-enable-saas/{companyId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), companyId (required).

ghl_saas_bulk_enable_deprecatedA

DEPRECATED per spec — superseded by POST /saas/bulk-enable-saas/{companyId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Bulk Enable SaaS Enable SaaS mode for multiple locations with support for both SaaS v1 and v2 Endpoint: POST /saas-api/public-api/bulk-enable-saas/{companyId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: body (required), companyId (required).

ghl_saas_enable_locationB

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Enable SaaS for Sub-Account (Formerly Location) Enable SaaS for Sub-Account (Formerly Location) based on the data provided

:::info This feature is only available on Agency Pro ($497) plan. ::: Endpoint: POST /saas/enable-saas/{locationId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), locationId (required).

ghl_saas_enable_location_deprecatedA

DEPRECATED per spec — superseded by POST /saas/enable-saas/{locationId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Enable SaaS for Sub-Account (Formerly Location)

Inputs: body (required), locationId (required).

ghl_saas_get_agency_plansA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Get Agency Plans Fetch all agency subscription plans for a given company ID Endpoint: GET /saas/agency-plans/{companyId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.read

Inputs: companyId (required).

ghl_saas_get_agency_plans_deprecatedA
Read-onlyIdempotent

DEPRECATED per spec — superseded by GET /saas/agency-plans/{companyId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Agency Plans Fetch all agency subscription plans for a given company ID Endpoint: GET /saas-api/public-api/agency-plans/{companyId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: companyId (required).

ghl_saas_get_locationsA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. page is a required query param per spec. Get SaaS Locations Fetch all SaaS-activated locations for a company with pagination Endpoint: GET /saas/saas-locations/{companyId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.read Pagination params: page — pass them to page through full result sets.

Inputs: page (required), companyId (required).

ghl_saas_get_locations_by_stripe_idB
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. customerId and subscriptionId are both required query params per spec (unlike the deprecated /saas-api twin, where they're optional). Get locations by stripeId with companyId Get locations by stripeCustomerId or stripeSubscriptionId with companyId Endpoint: GET /saas/locations (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.read

Inputs: customerId (required), subscriptionId (required).

ghl_saas_get_locations_by_stripe_id_deprecatedA
Read-onlyIdempotent

DEPRECATED per spec — superseded by GET /saas/locations. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get locations by stripeId with companyId Get locations by stripeCustomerId or stripeSubscriptionId with companyId Endpoint: GET /saas-api/public-api/locations (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: companyId (required), customerId, subscriptionId.

ghl_saas_get_locations_deprecatedA
Read-onlyIdempotent

DEPRECATED per spec — superseded by GET /saas/saas-locations/{companyId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get SaaS Locations Fetch all SaaS-activated locations for a company with pagination Endpoint: GET /saas-api/public-api/saas-locations/{companyId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token. Pagination params: page — pass them to page through full result sets.

Inputs: companyId (required), page.

ghl_saas_get_location_subscriptionB
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Get Location Subscription Details Fetch subscription details for a specific location from location metadata Endpoint: GET /saas/get-saas-subscription/{locationId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.read

Inputs: companyId (required), locationId (required).

ghl_saas_get_location_subscription_deprecatedA
Read-onlyIdempotent

DEPRECATED per spec — superseded by GET /saas/get-saas-subscription/{locationId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Location Subscription Details Fetch subscription details for a specific location from location metadata Endpoint: GET /saas-api/public-api/get-saas-subscription/{locationId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: companyId (required), locationId (required).

ghl_saas_get_location_wallet_balanceA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Get Location Wallet Balance Fetch the wallet balance for a specific location. Returns a resource object with balance details. Endpoint: GET /saas/companies/{companyId}/locations/{locationId}/wallet-balance (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.read

Inputs: companyId (required), locationId (required).

ghl_saas_get_planB
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Get SaaS Plan Fetch a specific SaaS plan by plan ID Endpoint: GET /saas/saas-plan/{planId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.read

Inputs: planId (required), companyId (required).

ghl_saas_get_plan_deprecatedA
Read-onlyIdempotent

DEPRECATED per spec — superseded by GET /saas/saas-plan/{planId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get SaaS Plan Fetch a specific SaaS plan by plan ID Endpoint: GET /saas-api/public-api/saas-plan/{planId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: planId (required), companyId (required).

ghl_saas_list_agency_wallet_transactionsA
Read-onlyIdempotent

List agency wallet transactions Fetch paginated wallet transactions for an agency (company). Supports skip/limit pagination, date-range and charge-type filters, timezone normalization, and additional non-indexed filters in the request body. Endpoint: POST /saas/companies/{companyId}/wallet-transactions (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.read

Inputs: body (required), companyId (required).

ghl_saas_list_location_wallet_transactionsA
Read-onlyIdempotent

List location wallet transactions Fetch paginated wallet transactions for a sub-account (location). Supports skip/limit pagination, date-range and charge-type filters, timezone normalization, and additional non-indexed filters in the request body. Endpoint: POST /saas/locations/{locationId}/wallet-transactions (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/location.read

Inputs: body (required), locationId (required).

ghl_saas_pause_locationB

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Pause location Pause Sub account for given locationId Endpoint: POST /saas/pause/{locationId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), locationId (required).

ghl_saas_pause_location_deprecatedA

DEPRECATED per spec — superseded by POST /saas/pause/{locationId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Pause location Pause Sub account for given locationId Endpoint: POST /saas-api/public-api/pause/{locationId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: body (required), locationId (required).

ghl_saas_remove_attached_configA

Remove attached config Clears attached SaaS plan (attachPlanId/attachPriceId) and/or attached rebilling config from a sub-account in setup_pending, and sets suspendedInfo.payment_pending to false. Endpoint: POST /saas/remove-attached-config/{locationId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), locationId (required).

ghl_saas_update_location_wallet_balanceA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Adds/adjusts complimentary wallet credits for the given location. Update Location Wallet Balance Update the wallet balance or complimentary credit settings for a specific location. Supports partial updates via updateMask field (AIP-134 compliant). Endpoint: POST /saas/companies/{companyId}/locations/{locationId}/wallet-balance/complimentary-credits (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), companyId (required), locationId (required).

ghl_saas_update_rebillingA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Update Rebilling Bulk update rebilling for given locationIds Endpoint: POST /saas/update-rebilling/{companyId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), companyId (required).

ghl_saas_update_rebilling_deprecatedA

DEPRECATED per spec — superseded by POST /saas/update-rebilling/{companyId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Update Rebilling Bulk update rebilling for given locationIds Endpoint: POST /saas-api/public-api/update-rebilling/{companyId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: body (required), companyId (required).

ghl_saas_update_saas_subscriptionA
Idempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Updates an existing SaaS subscription's plan/pricing for the location. NOTE: the generated name for this op was misleading ('generate_payment_link'); corrected to reflect what the op actually does, matching its summary 'Update SaaS subscription'. Update SaaS subscription Update SaaS subscription for given locationId and customerId Endpoint: PUT /saas/update-saas-subscription/{locationId} (Version header: v3; source: v3/saas-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

Inputs: body (required), locationId (required).

ghl_saas_update_saas_subscription_deprecatedA
Idempotent

DEPRECATED per spec — superseded by PUT /saas/update-saas-subscription/{locationId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. NOTE: the generated name for this op was misleading ('generate_payment_link'); corrected to reflect what the op actually does (updates an existing SaaS subscription plan/pricing), matching its summary 'Update SaaS subscription'. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Update SaaS subscription Update SaaS subscription for given locationId and customerId Endpoint: PUT /saas-api/public-api/update-saas-subscription/{locationId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

Inputs: body (required), locationId (required).

ghl_snapshot_get_latest_pushA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all snapshots ops. Get Last Snapshot Push Get Latest Snapshot Push Status for a location id Endpoint: GET /snapshots/snapshot-status/{snapshotId}/location/{locationId} (Version header: v3; source: v3/snapshots-v3.json) Requires an Agency (company-level) token.

Inputs: companyId (required), locationId (required), snapshotId (required).

ghl_snapshot_get_pushes_between_datesA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all snapshots ops. from/to/lastDoc are required query params per spec despite generic-sounding names. Get Snapshot Push between Dates Get list of sub-accounts snapshot pushed in time period Endpoint: GET /snapshots/snapshot-status/{snapshotId} (Version header: v3; source: v3/snapshots-v3.json) Requires an Agency (company-level) token. Pagination params: limit — pass them to page through full result sets.

Inputs: to (required), from (required), lastDoc (required), companyId (required), +2 more.

ghl_snapshot_listA
Read-onlyIdempotent

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all snapshots ops. Get Snapshots Get a list of all own and imported Snapshots Endpoint: GET /snapshots/ (Version header: v3; source: v3/snapshots-v3.json) Requires an Agency (company-level) token.

Inputs: companyId (required).

ghl_social_add_watermark_on_imageA

Apply watermark to an image Apply a watermark to an image using either a specific template ID or by resolving the template bound to a specific connected account.

If the same watermark + image combination has been processed before, the response returns immediately with status: completed and the output URL in message. Otherwise, processing is queued and the response returns status: pending with a progressId.

Rate limits: This endpoint may be rate-limited to prevent abuse. To resolve a template dynamically at publish time, pass accountId — the endpoint will resolve the template bound to that connected account. Use the Get Accounts endpoint to look up account IDs.

Processing is asynchronous — the response returns a progressId that identifies this preview job.

Document fields:

  • status: 'pending' | 'processing' | 'completed' | 'failed'

  • outputMediaUrl: string, available when status is completed

  • errorMessage: string, available when status is failed Endpoint: POST /social-media-posting/{locationId}/watermarks/add-image-watermark (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/watermarks.write

Inputs: body (required), locationId (required).

ghl_social_attach_facebook_page_groupC

Attach facebook pages Endpoint: POST /social-media-posting/oauth/{locationId}/facebook/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: body (required), accountId (required), locationId (required).

ghl_social_attach_instagram_page_groupC

Attach Instagram Professional Accounts Endpoint: POST /social-media-posting/oauth/{locationId}/instagram/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: body (required), accountId (required), locationId (required).

ghl_social_attach_linkedin_page_profileC

Attach linkedin pages and profile Endpoint: POST /social-media-posting/oauth/{locationId}/linkedin/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: body (required), accountId (required), locationId (required).

ghl_social_attach_oauth_accountsA

Connect Account (Step 3 of 3)

OAuth Connection Flow - Step 3: Connect the Account

This is the final step in the OAuth flow. After retrieving available accounts (Step 2), use this endpoint to connect the selected account to your location.

OAuth Flow Summary

  1. Start OAuth → User authenticates with platform

  2. Get Accounts → Retrieved available pages/channels

  3. Attach Account (this endpoint) → Connect the selected account

Request Body

The accepted fields depend on the platform path parameter — pick the matching schema in the request body below. Most platforms take the originId, name and optional avatar of the account you selected in Step 2; Google Business Profile takes the full location and account objects.

tiktok-business accounts are connected through the TikTok Business flow, not this endpoint.

After Connection

Once connected, the account will appear in your location's connected accounts and can be used for social media posting. Endpoint: POST /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/oauth.write

Inputs: body (required), platform (required), accountId (required), locationId (required).

ghl_social_attach_tiktok_profileC

Attach Tiktok profile Endpoint: POST /social-media-posting/oauth/{locationId}/tiktok/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: body (required), accountId (required), locationId (required).

ghl_social_attach_twitter_profileA

[DEPRECATED per official docs — prefer the documented replacement if one exists.] Attach Twitter profile

Inputs: body (required), accountId (required), locationId (required).

ghl_social_bulk_delete_planner_postsB

Bulk Delete Social Planner Posts Deletes multiple posts based on the provided list of post IDs. This operation is useful for clearing up large numbers of posts efficiently.

Note:

1.The maximum number of posts that can be deleted in a single request is '50'.

2.However, It will only get deleted in the platform database but still it is recommended to be cautious of this operation. Endpoint: POST /social-media-posting/{locationId}/posts/bulk-delete (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/post.write

Inputs: body (required), locationId (required).

ghl_social_category_getA
Read-onlyIdempotent

Get category by ID Retrieve a specific category by its ID Endpoint: GET /social-media-posting/{locationId}/categories/{id} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/category.readonly

Inputs: id (required), locationId (required).

ghl_social_category_listA
Read-onlyIdempotent

Get categories by location ID Retrieve all categories for a specific location with optional search and pagination Endpoint: GET /social-media-posting/{locationId}/categories (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/category.readonly Pagination params: limit, skip — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, searchText.

ghl_social_clone_queue_itemA

Clone a queue item Duplicates an existing queue item at a specified order position. Requires an active edit session. Endpoint: POST /social-media-posting/category/queues/{queueId}/items/{itemId}/clone (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required), itemId (required), queueId (required).

ghl_social_create_commentA

Create a comment or reply Create a top-level comment on a post (isParentThread: true, parentId = postId) or a reply to an existing comment (isParentThread: false, parentId = commentId). Per-platform content max length: Facebook 8000, Instagram 2200, Linkedin 3000, Community 8000, Tiktok 150, Bluesky 300, Youtube 10000, Threads 500.

Optional-field platform support:

  • attachments — supported on Facebook only. Ignored on Instagram, LinkedIn, TikTok, Bluesky, Community (Community processes the field but external URLs are not rendered due to its bucket restriction).

  • mentions — supported on Facebook, LinkedIn, and Community only. Ignored on Instagram, TikTok, Bluesky.

  • notifyAllGroupMembers — supported on Community only. When true, all group members get a push/in-app notification (equivalent to an @everyone broadcast). Independent of the mentions array and of @everyone text in content. Default false. Endpoint: POST /social-media-posting/comments/{platform} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/comments.write

Inputs: body (required), platform (required), locationId (required).

ghl_social_create_likeA

Like a comment Like a comment by its internal comment ID (the _id returned by the list-comments endpoint — not the native platform ID).

Works for any comment level — top-level comments, replies, and replies-to-replies. Supported platforms: Facebook, LinkedIn, Community, TikTok, Bluesky. Instagram is not supported (passing instagram returns 400). Endpoint: POST /social-media-posting/comments/{platform}/{id}/like (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/comments.write

Inputs: id (required), platform (required), locationId (required).

ghl_social_create_queueA

Create a new category queue Creates a queue in draft status for a category. Published posts are auto-added. Use update endpoint to activate. Endpoint: POST /social-media-posting/category/queues (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required).

ghl_social_create_queue_itemB

Create a new item in the queue Adds a new post item to a queue. Use sessionId for edit session or directToQueue for immediate addition. Endpoint: POST /social-media-posting/category/queues/{queueId}/create/item (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required), queueId (required).

ghl_social_create_watermarkA

Create a watermark template Create a new reusable watermark template for a location. The template stores the watermark image URL, position, scale, opacity, padding, and the connected accounts it applies to.

At post-publish time, the template is resolved for a given connected account via the accountIds binding — the accountId you provide here maps a connected social account to this template. To fetch account IDs, use the Get Accounts endpoint. Endpoint: POST /social-media-posting/{locationId}/watermarks (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/watermarks.write

Inputs: body (required), locationId (required).

ghl_social_csv_finalizeA

Finalizes a previously uploaded CSV import and schedules all its posts for publishing (operationId start-csv-finalize). Start CSV Finalize Finalize a CSV import and schedule all posts for publishing Endpoint: PATCH /social-media-posting/{locationId}/csv/{id} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/csv.write

Inputs: id (required), body (required), locationId (required).

ghl_social_csv_listA
Read-onlyIdempotent

Lists the status of ALL CSV bulk-import batches for the location (operationId get-upload-status — the name is misleading; it's a paginated list, not a single status check). Supports skip/limit; userId query param is required per spec. Get Upload Status Get the status of all CSV imports for a location Endpoint: GET /social-media-posting/{locationId}/csv (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/csv.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: userId (required), locationId (required), skip, limit, +2 more.

ghl_social_csv_uploadA

multipart/form-data upload, body.file (binary CSV) required — there is no URL-based alternative for this endpoint (unlike media upload). This tool does not construct the multipart payload for you; the body argument is sent to GHL verbatim as the request body, so the caller must already have a valid pre-encoded multipart/form-data payload (with boundary) to pass through. Upload CSV Upload a CSV file containing social media posts for bulk scheduling Endpoint: POST /social-media-posting/{locationId}/csv (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/csv.write

Inputs: body (required), locationId (required).

ghl_social_delete_accountA
DestructiveIdempotent

Delete Account Delete account and account from group Endpoint: DELETE /social-media-posting/{locationId}/accounts/{id} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/account.write

Inputs: id (required), locationId (required), userId.

ghl_social_delete_csvA
DestructiveIdempotent

Delete CSV Delete a CSV import and all its associated posts Endpoint: DELETE /social-media-posting/{locationId}/csv/{id} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/csv.write

Inputs: id (required), locationId (required).

ghl_social_delete_csv_postA
DestructiveIdempotent

Delete CSV Post Delete a specific post from a CSV import Endpoint: DELETE /social-media-posting/{locationId}/csv/{csvId}/post/{postId} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/csv.write

Inputs: csvId (required), postId (required), locationId (required).

ghl_social_delete_current_active_post_and_schedule_nextB
DestructiveIdempotent

Delete an active post and schedule the next one Deletes a post that is currently scheduled and automatically triggers the scheduling of the next available post in the queue. Endpoint: DELETE /social-media-posting/category/queues/{postId}/active-post (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: postId (required), locationId (required).

ghl_social_delete_likeA
DestructiveIdempotent

Unlike a comment Remove a like from a comment by its internal comment ID (the _id returned by the list-comments endpoint — not the native platform ID).

Works for any comment level — top-level comments, replies, and replies-to-replies. Supported platforms: Facebook, LinkedIn, Community, TikTok, Bluesky. Instagram is not supported (passing instagram returns 400). Endpoint: DELETE /social-media-posting/comments/{platform}/{id}/like (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/comments.write

Inputs: id (required), platform (required), locationId (required).

ghl_social_delete_postA
DestructiveIdempotent

Delete Post Endpoint: DELETE /social-media-posting/{locationId}/posts/{id} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/post.write

Inputs: id (required), locationId (required).

ghl_social_delete_queue_itemB
DestructiveIdempotent

Delete an item from a queue Deletes an item from a specific category queue. Endpoint: DELETE /social-media-posting/category/queues/{queueId}/items/{itemId} (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: itemId (required), queueId (required), locationId (required), sessionId.

ghl_social_delete_watermarkA
DestructiveIdempotent

Delete a watermark template by ID Soft-delete a watermark template. The template is marked as deleted and no longer applies at post-publish time, but the record is preserved in the database. Any accounts previously bound via accountIds are released and become eligible for other templates. Endpoint: DELETE /social-media-posting/{locationId}/watermarks/{templateId} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/watermarks.write

Inputs: locationId (required), templateId (required).

ghl_social_discard_edit_sessionA

Discard edit session changes Cancels the edit session and deletes all staged changes without affecting the live queue. Endpoint: POST /social-media-posting/category/queues/{queueId}/edit/discard (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required), queueId (required).

ghl_social_edit_postC
Idempotent

Edit post Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitting the create post API multiple times with different summaries and account IDs per platform.

The content and media limitations, as well as platform rate limiters corresponding to the respective platforms, are provided in the following reference link:

Link: Platform Limitations Endpoint: PUT /social-media-posting/{locationId}/posts/{id} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/post.write

Inputs: id (required), body (required), locationId (required).

ghl_social_fetch_available_categoriesA
Read-onlyIdempotent

Get all categories with their queue status Returns categories with status: "available" (no queue), "in_queue" (active/paused queue), or "draft" (queue in draft). Endpoint: GET /social-media-posting/category/queues/available-categories (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), q, skip, limit.

ghl_social_fetch_calendar_listB

Get scheduled posts calendar view Returns scheduled posts from active queues within a date range. Supports filtering by categories and accounts. Endpoint: POST /social-media-posting/category/queues/list/calendar (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.readonly

Inputs: body (required).

ghl_social_fetch_edit_session_calendarA

Fetch calendar view for an edit session Retrieves a calendar preview of scheduled posts based on draft items within an edit session. This shows how posts would be scheduled if changes were saved. Endpoint: POST /social-media-posting/category/queues/{queueId}/edit/calendar (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.readonly

Inputs: body (required), queueId (required).

ghl_social_fetch_queue_by_idA
Read-onlyIdempotent

Fetch a category queue by ID Retrieves the details of a single category queue by its unique ID. The response includes a count of posts within the queue that have errors. Endpoint: GET /social-media-posting/category/queues/{queueId} (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.readonly

Inputs: queueId (required), locationId (required).

ghl_social_fetch_queue_itemsA

Fetch items from a queue Returns paginated queue items. Pass sessionId to get draft items from an edit session instead of live items. Endpoint: POST /social-media-posting/category/queues/{queueId}/items (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.readonly

Inputs: body (required), queueId (required).

ghl_social_fetch_queuesB

Fetch category queues for a location Retrieves a paginated list of all category queues for a given location, excluding any that have been marked as deleted. Endpoint: POST /social-media-posting/category/queues/list (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.readonly

Inputs: body (required).

ghl_social_fetch_slotsA

Fetch slot information for queue items Returns paginated slot information (scheduledDateTime, isSkipped) for queue items. Pass sessionId to get slots for draft items, or omit for live items. Call this after mutations to refresh slot data. Endpoint: POST /social-media-posting/category/queues/{queueId}/slots (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.readonly

Inputs: body (required), queueId (required).

ghl_social_get_accountA
Read-onlyIdempotent

Get Accounts Get list of accounts and groups Endpoint: GET /social-media-posting/{locationId}/accounts (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/account.readonly

Inputs: locationId (required).

ghl_social_get_all_watermarksA
Read-onlyIdempotent

List watermark templates Retrieve a paginated list of watermark templates for a specific location. Each template exposes the connected accounts it applies to via accountIds. Use the Get Accounts endpoint to look up account IDs. Endpoint: GET /social-media-posting/{locationId}/watermarks (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/watermarks.readonly Pagination params: limit, skip — pass them to page through full result sets.

Inputs: locationId (required), name, skip, limit.

ghl_social_get_comment_listA

List comments for a post or thread Paginated list of comments scoped to a post (parentId = postId) or a comment thread (parentId = commentId). Use skip/limit for pagination, sortBy for ordering, originIds to filter by connected account, and search for keyword search. Endpoint: POST /social-media-posting/comments/{platform}/list (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/comments.readonly

Inputs: body (required), platform (required), locationId (required).

ghl_social_get_community_usersA
Read-onlyIdempotent

Get Community Members List the members you can publish a post as, for one connected Community channel.

accountId is the Community account ID from the Get Accounts API. Each Community account represents one channel and members are scoped to it: for a private channel only that channel's members are returned, for a public channel the group's members are. Always list members per account rather than reusing one list across accounts.

Pass a returned contactId as communityPostDetails.postAsUser[accountId].id when creating a post. Only members who can publish are returned — a member must be Active and hold a role in the group.

Results are paginated; meta.nextPage is null on the last page. Endpoint: GET /social-media-posting/{locationId}/community/accounts/{accountId}/users (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/oauth.readonly Pagination params: limit — pass them to page through full result sets.

Inputs: accountId (required), locationId (required), limit, pageNo, +1 more.

ghl_social_get_csv_postA
Read-onlyIdempotent

Get CSV Post Get details of a specific CSV import including its posts Endpoint: GET /social-media-posting/{locationId}/csv/{id} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/csv.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: id (required), locationId (required), skip, limit.

ghl_social_get_facebook_page_groupB
Read-onlyIdempotent

Get facebook pages Endpoint: GET /social-media-posting/oauth/{locationId}/facebook/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: accountId (required), locationId (required).

ghl_social_get_google_locationsB
Read-onlyIdempotent

Get google business locations Endpoint: GET /social-media-posting/oauth/{locationId}/google/locations/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: accountId (required), locationId (required).

ghl_social_get_instagram_page_groupB
Read-onlyIdempotent

Get Instagram Professional Accounts Endpoint: GET /social-media-posting/oauth/{locationId}/instagram/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: accountId (required), locationId (required).

ghl_social_get_linkedin_page_profileC
Read-onlyIdempotent

Get Linkedin pages and profile Endpoint: GET /social-media-posting/oauth/{locationId}/linkedin/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: accountId (required), locationId (required).

ghl_social_get_oauth_accountsA
Read-onlyIdempotent

Get Available Accounts (Step 2 of 3)

OAuth Connection Flow - Step 2: Get Available Accounts

After completing OAuth authentication (Step 1), use this endpoint to retrieve the list of available pages, channels, or locations that can be connected.

OAuth Flow Position

  1. Start OAuth → User authenticates, returns accountId

  2. Get Accounts (this endpoint) → Lists available pages/channels to connect

  3. Attach Account → Connect the selected account

What This Returns

The response varies by platform:

Platform

Returns

facebook

List of Facebook Pages the user manages

instagram

List of Instagram Professional Accounts (linked to Facebook Pages)

google

Google Business Profile locations

linkedin

LinkedIn Pages and Profile

tiktok

TikTok Creator account info

tiktok-business

TikTok Business Center accounts

youtube

YouTube Channels

pinterest

Pinterest Business accounts and boards

threads

Threads profiles

Next Step

From the response, select the account/page you want to connect and use its details in Step 3:

POST /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId}

Endpoint: GET /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/oauth.readonly

Inputs: platform (required), accountId (required), locationId (required), search.

ghl_social_get_postB
Read-onlyIdempotent

Get post Endpoint: GET /social-media-posting/{locationId}/posts/{id} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/post.readonly

Inputs: id (required), locationId (required).

ghl_social_get_postsB

Get posts Get Posts Endpoint: POST /social-media-posting/{locationId}/posts/list (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/post.readonly

Inputs: body (required), locationId (required).

ghl_social_get_statisticsA

Get Social Media Statistics Retrieve analytics data for multiple social media accounts. Supports custom date ranges for both the current period and a comparison period. If no date ranges are provided, defaults to the last 7 days (excluding today) with comparison to the previous 7 days. Endpoint: POST /social-media-posting/statistics (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/statistics.readonly

Inputs: body (required), locationId (required).

ghl_social_get_tags_by_idsA

Get tags by IDs Retrieve specific tags by their IDs Endpoint: POST /social-media-posting/{locationId}/tags/details (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/tag.readonly

Inputs: body (required), locationId (required).

ghl_social_get_tags_location_idA
Read-onlyIdempotent

Get tags by location ID Retrieve all tags for a specific location with optional search and pagination Endpoint: GET /social-media-posting/{locationId}/tags (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/tag.readonly Pagination params: limit, skip — pass them to page through full result sets.

Inputs: locationId (required), skip, limit, searchText.

ghl_social_get_tiktok_business_profileA
Read-onlyIdempotent

Get Tiktok Business profile Endpoint: GET /social-media-posting/oauth/{locationId}/tiktok-business/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: accountId (required), locationId (required).

ghl_social_get_tiktok_profileC
Read-onlyIdempotent

Get Tiktok profile Endpoint: GET /social-media-posting/oauth/{locationId}/tiktok/accounts/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: accountId (required), locationId (required).

ghl_social_get_twitter_profileB
Read-onlyIdempotent

[DEPRECATED per official docs — prefer the documented replacement if one exists.] Get Twitter profile

Inputs: accountId (required), locationId (required).

ghl_social_get_watermarkA
Read-onlyIdempotent

Get a watermark template by ID Retrieve the full details of a specific watermark template, including its image URL, position, scale, opacity, padding, template name, and the connected accounts it applies to (accountIds). Use the Get Accounts endpoint to look up account IDs. Endpoint: GET /social-media-posting/{locationId}/watermarks/{templateId} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/watermarks.readonly

Inputs: locationId (required), templateId (required).

ghl_social_post_createA

KNOWN LIVE REGRESSION (as of 2026-07-04): this endpoint was observed broken/failing in production even though its documented schema (top-level accountIds/summary/media/status/type/userId, platform-specific *PostDetails objects) is correct and faithfully reproduced here. If a call fails, the schema/tool is not at fault — treat it as a possible server-side GHL issue and check the response body for details before assuming a client-side mistake. Create post Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitting the create post API multiple times with different summaries and account IDs per platform.

The content and media limitations, as well as platform rate limiters corresponding to the respective platforms, are provided in the following reference link:

Link: Platform Limitations Endpoint: POST /social-media-posting/{locationId}/posts (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/post.write

Inputs: body (required), locationId (required).

ghl_social_reset_queue_itemA
Idempotent

Reset an item in a queue Resets a specific queue item to its original state, discarding any modifications made. Endpoint: PUT /social-media-posting/category/queues/{queueId}/items/{itemId}/reset (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required), itemId (required), queueId (required).

ghl_social_save_edit_sessionA

Save edit session changes Applies all staged changes to the live queue and closes the edit session. Endpoint: POST /social-media-posting/category/queues/{queueId}/edit/save (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required), queueId (required).

ghl_social_set_accountsA

Set Accounts Set social media accounts for a CSV import to publish posts to Endpoint: POST /social-media-posting/{locationId}/set-accounts (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/csv.write

Inputs: body (required), locationId (required).

ghl_social_set_google_locationsC

Set google business locations Endpoint: POST /social-media-posting/oauth/{locationId}/google/locations/{accountId} (Version header: 2021-07-28; source: social-media-posting.json)

Inputs: body (required), accountId (required), locationId (required).

ghl_social_start_edit_sessionA

Start or resume an edit session Creates a draft copy of queue items for editing. Changes are staged until saved or discarded. Endpoint: POST /social-media-posting/category/queues/{queueId}/edit/start (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required), queueId (required).

ghl_social_update_queueA
Idempotent

Update queue settings or status Updates queue status (active/paused/deleted), time slots, or skip dates. Endpoint: PUT /social-media-posting/category/queues/{queueId} (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required), queueId (required).

ghl_social_update_queue_itemB
Idempotent

Update an item in a queue Updates the content or variations of a specific item within a category queue. Endpoint: PUT /social-media-posting/category/queues/{queueId}/items/{itemId} (Version header: v3; source: v3/social-planner-v3.json) OAuth scopes: socialplanner/category.write

Inputs: body (required), itemId (required), queueId (required).

ghl_social_update_watermarkA
Idempotent

Update a watermark template by ID Update the config on an existing watermark template — image URL, position, scale, opacity, padding, template name, or the connected accounts it applies to. Updating accountIds re-binds the template to a different set of accounts; use the Get Accounts endpoint to look up account IDs. Endpoint: PUT /social-media-posting/{locationId}/watermarks/{templateId} (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/watermarks.write

Inputs: body (required), locationId (required), templateId (required).

ghl_social_validate_community_user_membershipA
Read-onlyIdempotent

Validate Community Member Check whether a contact can publish in a Community group. isActive is true only when the contact is an active member holding a role — the same condition enforced when a post is published, so use this to confirm a stored postAsUser is still valid before scheduling.

groupId is the meta.groupId of a Community account from the Get Accounts API. contactId is the contactId of a member returned by the Get Community Members API. Endpoint: GET /social-media-posting/{locationId}/community/groups/{groupId}/users/{contactId}/validate (Version header: v3; source: v3/social-planner-v3.json) Requires a Sub-Account (location) token. OAuth scopes: socialplanner/account.readonly

Inputs: groupId (required), contactId (required), locationId (required).

ghl_store_create_shipping_carrierB

Create Shipping Carrier The "Create Shipping Carrier" API allows adding a new shipping carrier. Endpoint: POST /store/shipping-carrier (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required).

ghl_store_create_shipping_rateC

Create Shipping Rate The "Create Shipping Rate" API allows adding a new shipping rate. Endpoint: POST /store/shipping-zone/{shippingZoneId}/shipping-rate (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required), shippingZoneId (required).

ghl_store_create_shipping_zoneA

Create Shipping Zone The "Create Shipping Zone" API allows adding a new shipping zone. Endpoint: POST /store/shipping-zone (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required).

ghl_store_delete_shipping_carrierA
DestructiveIdempotent

Delete shipping carrier Delete specific shipping carrier with Id :shippingCarrierId Endpoint: DELETE /store/shipping-carrier/{shippingCarrierId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required), shippingCarrierId (required).

ghl_store_delete_shipping_rateB
DestructiveIdempotent

Delete shipping rate Delete specific shipping rate with Id :shippingRateId Endpoint: DELETE /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required), shippingRateId (required), shippingZoneId (required).

ghl_store_delete_shipping_zoneA
DestructiveIdempotent

Delete shipping zone Delete specific shipping zone with Id :shippingZoneId Endpoint: DELETE /store/shipping-zone/{shippingZoneId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required), shippingZoneId (required).

ghl_store_get_available_shipping_ratesB

Returns the shipping rates available for a given country/order-amount combination. (Generated tool name was originally 'ghl_store_get_available_shipping_zones', which misdescribed the response — this endpoint returns rates, not zones; corrected here.) Get available shipping rates This return available shipping rates for country based on order amount Endpoint: POST /store/shipping-zone/shipping-rates (Version header: v3; source: v3/store-v3.json)

Inputs: body (required).

ghl_store_get_settingsB
Read-onlyIdempotent

Get Store Settings Get store settings by altId and altType. Endpoint: GET /store/store-setting (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required).

ghl_store_get_shipping_carrierC
Read-onlyIdempotent

Get Shipping Carrier The "List Shipping Carrier" API allows to retrieve a paginated list of shipping carrier. Endpoint: GET /store/shipping-carrier/{shippingCarrierId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required), shippingCarrierId (required).

ghl_store_get_shipping_rateB
Read-onlyIdempotent

Get Shipping Rate The "List Shipping Rate" API allows to retrieve a paginated list of shipping rate. Endpoint: GET /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required), shippingRateId (required), shippingZoneId (required).

ghl_store_get_shipping_zoneC
Read-onlyIdempotent

Get Shipping Zone The "List Shipping Zone" API allows to retrieve a paginated list of shipping zone. Endpoint: GET /store/shipping-zone/{shippingZoneId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required), shippingZoneId (required), withShippingRate.

ghl_store_list_shipping_carriersA
Read-onlyIdempotent

List Shipping Carriers The "List Shipping Carrier" API allows to retrieve a list of shipping carrier. Endpoint: GET /store/shipping-carrier (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: altId (required), altType (required).

ghl_store_list_shipping_ratesA
Read-onlyIdempotent

List Shipping Rates The "List Shipping Rate" API allows to retrieve a list of shipping rate. Endpoint: GET /store/shipping-zone/{shippingZoneId}/shipping-rate (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token. Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), shippingZoneId (required), limit, +1 more.

ghl_store_list_shipping_zonesA
Read-onlyIdempotent

List Shipping Zones The "List Shipping Zone" API allows to retrieve a list of shipping zone. Endpoint: GET /store/shipping-zone (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token. Pagination params: limit, offset — pass them to page through full result sets.

Inputs: altId (required), altType (required), limit, offset, +1 more.

ghl_store_update_shipping_carrierA
Idempotent

Update Shipping Carrier The "update Shipping Carrier" API allows update a shipping carrier to the system. Endpoint: PUT /store/shipping-carrier/{shippingCarrierId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required), shippingCarrierId (required).

ghl_store_update_shipping_rateB
Idempotent

Update Shipping Rate The "update Shipping Rate" API allows update a shipping rate to the system. Endpoint: PUT /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required), shippingRateId (required), shippingZoneId (required).

ghl_store_update_shipping_zoneB
Idempotent

Update Shipping Zone The "update Shipping Zone" API allows update a shipping zone to the system. Endpoint: PUT /store/shipping-zone/{shippingZoneId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required), shippingZoneId (required).

ghl_store_upsert_settingsB

Creates the store settings record if none exists yet, otherwise updates it in place (per spec summary 'Create/Update Store Settings'). Create/Update Store Settings Create or update store settings by altId and altType. Endpoint: POST /store/store-setting (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

Inputs: body (required).

ghl_survey_get_submissionsB
Read-onlyIdempotent

Get Surveys Submissions Endpoint: GET /surveys/submissions (Version header: v3; source: v3/surveys-v3.json) OAuth scopes: surveys.readonly Pagination params: page, limit — pass them to page through full result sets.

Inputs: locationId (required), q, page, endAt, +3 more.

ghl_survey_listB
Read-onlyIdempotent

Get Surveys Endpoint: GET /surveys/ (Version header: v3; source: v3/surveys-v3.json) OAuth scopes: surveys.readonly Pagination params: skip, limit — pass them to page through full result sets.

Inputs: locationId (required), skip, type, limit.

ghl_user_createB

Create User Endpoint: POST /users/ (Version header: v3; source: v3/users-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: users.write

Inputs: body (required).

ghl_user_deleteB
DestructiveIdempotent

KNOWN ISSUE: the official spec omits userId from this operation's path-parameter list (only the GET sibling declares it, despite all three sharing the same {userId} path template), so this tool currently has no input field for userId and calls will fail with a missing-path-parameter error until the generator (src/registry.ts) is patched to infer path params from the URL template. Tracked in this file's notes. Delete User Endpoint: DELETE /users/{userId} (Version header: v3; source: v3/users-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: users.write

Inputs: userId (required).

ghl_user_filter_by_emailA

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access only (no Location-Access alternative), unlike the other /users/* ops in this file. Filter Users by Email Filter users by company ID, deleted status, and email array Endpoint: POST /users/search/filter-by-email (Version header: v3; source: v3/users-v3.json) Requires an Agency (company-level) token. OAuth scopes: users.readonly

Inputs: body (required).

ghl_user_getA
Read-onlyIdempotent

Get User Endpoint: GET /users/{userId} (Version header: v3; source: v3/users-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: users.readonly

Inputs: userId (required).

ghl_user_get_by_locationA
Read-onlyIdempotent

DEPRECATED per spec — superseded by GET /users/search (v3), which supports the same locationId filter plus richer query/paging options. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get User by Location Deprecated. Use GET /users/search instead. Pass locationId as a query parameter to filter results by location, along with the required companyId and other search filters as needed. Endpoint: GET /users/ (Version header: 2021-07-28; source: users.json) Requires a Sub-Account (location) token. OAuth scopes: users.readonly

Inputs: locationId (required).

ghl_user_updateB
Idempotent

KNOWN ISSUE: the official spec omits userId from this operation's path-parameter list (only the GET sibling declares it, despite all three sharing the same {userId} path template), so this tool currently has no input field for userId and calls will fail with a missing-path-parameter error until the generator (src/registry.ts) is patched to infer path params from the URL template. Tracked in this file's notes. Update User Endpoint: PUT /users/{userId} (Version header: v3; source: v3/users-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: users.write

Inputs: body (required), userId (required).

ghl_voice_ai_create_actionA

Create Agent Action Create a new action for a voice AI agent. Actions define specific behaviors and capabilities for the agent during calls. Endpoint: POST /voice-ai/actions (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agent-goals.write

Inputs: body (required).

ghl_voice_ai_create_agentB

Create Agent Create a new voice AI agent configuration and settings Endpoint: POST /voice-ai/agents (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agents.write

Inputs: body (required).

ghl_voice_ai_delete_actionA
DestructiveIdempotent

Delete Agent Action Delete an existing action from a voice AI agent. This permanently removes the action and its configuration. Endpoint: DELETE /voice-ai/actions/{actionId} (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agent-goals.write

Inputs: agentId (required), actionId (required), locationId (required).

ghl_voice_ai_delete_agentB
DestructiveIdempotent

Delete Agent Delete a voice AI agent and all its configurations Endpoint: DELETE /voice-ai/agents/{agentId} (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agents.write

Inputs: agentId (required), locationId (required).

ghl_voice_ai_get_actionA
Read-onlyIdempotent

Get Agent Action Retrieve details of a specific action by its ID. Returns the action configuration including actionParameters. Endpoint: GET /voice-ai/actions/{actionId} (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agent-goals.readonly

Inputs: actionId (required), locationId (required).

ghl_voice_ai_get_agentA
Read-onlyIdempotent

Get Agent Retrieve detailed configuration and settings for a specific voice AI agent Endpoint: GET /voice-ai/agents/{agentId} (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agents.readonly

Inputs: agentId (required), locationId (required).

ghl_voice_ai_get_call_logB
Read-onlyIdempotent

Get Call Log Returns a call log by callId. Endpoint: GET /voice-ai/dashboard/call-logs/{callId} (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-dashboard.readonly

Inputs: callId (required), locationId (required).

ghl_voice_ai_get_call_logsA
Read-onlyIdempotent

List Call Logs Returns call logs for Voice AI agents scoped to a location. Supports filtering by agent, contact, call type, action types, and date range (interpreted in the provided IANA timezone). Also supports sorting and 1-based pagination. Endpoint: GET /voice-ai/dashboard/call-logs (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-dashboard.readonly Pagination params: page, pageSize — pass them to page through full result sets.

Inputs: locationId (required), page, sort, sortBy, +7 more.

ghl_voice_ai_list_agentsA
Read-onlyIdempotent

List Agents Retrieve a paginated list of agents for given location. Endpoint: GET /voice-ai/agents (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agents.readonly Pagination params: page, pageSize — pass them to page through full result sets.

Inputs: locationId (required), page, query, pageSize.

ghl_voice_ai_patch_agentB

Patch Agent Partially update an existing voice AI agent Endpoint: PATCH /voice-ai/agents/{agentId} (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agents.write

Inputs: body (required), agentId (required), locationId (required).

ghl_voice_ai_update_actionA
Idempotent

Update Agent Action Update an existing action for a voice AI agent. Modifies the behavior and configuration of an agent action. Endpoint: PUT /voice-ai/actions/{actionId} (Version header: v3; source: v3/voice-ai-v3.json) OAuth scopes: voice-ai-agent-goals.write

Inputs: body (required), actionId (required).

ghl_workflow_createA

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Create Workflow Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Create a workflow from a complete definition. The definition is validated in full before anything is persisted, so a rejected request creates nothing. Workflows are always created in draft; use Update Workflow Status to publish. Endpoint: POST /workflows/ (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.write

Inputs: body (required), locationId (required).

ghl_workflow_deleteA
DestructiveIdempotent

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Delete Workflow Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Delete a workflow. This also ends any enrollments in progress, so contacts currently moving through the workflow stop where they are. Treat it as permanent. Endpoint: DELETE /workflows/{workflowId} (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.delete

Inputs: locationId (required), workflowId (required).

ghl_workflow_get_definitionA
Read-onlyIdempotent

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Get Workflow Definition Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Read a workflow as a complete definition. The definition object is accepted verbatim by Update Workflow Definition, so it round-trips.

The definition's version is the workflow's own counter. Leave it as it comes back: sending it unchanged on update is what stops a concurrent edit in the builder from being silently overwritten. Endpoint: GET /workflows/{workflowId}/definition (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.readonly

Inputs: locationId (required), workflowId (required).

ghl_workflow_get_logsA
Read-onlyIdempotent

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Get Workflow Logs Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

List the step-by-step execution history of one workflow, newest first. Each record is one step of one run for one contact or record, with its outcome and timing. It answers who and what: who entered, what happened to a contact, which steps failed and for whom. To answer how many, use Get Workflow Log Statistics.

Before you call it. Get workflowId from Search Workflows. Never pass a workflow name. To see what each step is, call Get Workflow Definition: its actions[].id matches stepId here.

Step details. meta says how the contact entered, why a step was skipped or failed, what a step did, whether a wait timed out, and why the contact left. A key is left out when it does not apply. Only the keys documented under meta are returned. New keys may be added later (see Compatibility).

Paging. The response holds logs, their count, and nextCursor. The first call (action=first, the default) returns the newest page. For the next (older) page, send action=next with referenceId and referenceCreatedAt from nextCursor, unchanged, and keep the same filters and dates. nextCursor is null when there are no more records. A cursor that does not match returns 422. A page holds at most 100 records, 15 by default.

Dates. Send startDate and endDate together (ISO 8601, UTC, at most Endpoint: GET /workflows/{workflowId}/logs (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.logs Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), workflowId (required), limit, types, +10 more.

ghl_workflow_get_log_statisticsA
Read-onlyIdempotent

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Get Workflow Log Statistics Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Count the log records of one workflow, grouped by one or more dimensions. It answers how many: enrollments, completions, failures per step, why contacts left, and trends over time. To answer who, use Get Workflow Logs.

Before you call it. Get workflowId from Search Workflows. Never pass a workflow name.

Grouping. Each row holds one value for every dimension in groupBy, plus count. Grouping by week, day or hour adds bucket, the start of each interval in timezone. startDate and endDate always stay UTC. Rows are sorted by the grouped values in ascending order (status, then type, stepId, removedReason and bucket), not by count.

Finding filter values. Group by a dimension to see which values this workflow has, then filter on them. For example, groupBy=removedReason lists the reasons present, and those values work in removedReasons.

Steps. Rows grouped by stepId also carry stepName, the name of that step on its most recent log record in the date range. stepId matches actions[].id in Get Workflow Definition. A step count includes the remove_from_workflow record written when a contact leaves the workflow at that step, so group by stepId and type together to count how often the step itself ran.

Common questions.

  • Enrollments: `statuses=added_ Endpoint: GET /workflows/{workflowId}/logs/aggregate (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.logs Pagination params: limit — pass them to page through full result sets.

Inputs: locationId (required), workflowId (required), limit, types, +6 more.

ghl_workflow_get_step_typesA
Read-onlyIdempotent

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Get Step Types Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Browse or fetch the action and trigger schemas available to a sub-account, so a definition can be built against real field names before saving.

Every response is paged and every entry carries its full field schema, including the assetReferences that say which fields must hold IDs of assets that already exist. Default page size is 20.

Narrow with types, which matches on the step type key and matches partially — email returns send_email as well as email. Use query instead to match names and descriptions too. Page with limit and skip. Endpoint: GET /workflows/step-types (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.readonly Pagination params: limit, skip — pass them to page through full result sets.

Inputs: locationId (required), kind, skip, limit, +2 more.

ghl_workflow_listC
Read-onlyIdempotent

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Get Workflow Endpoint: GET /workflows/ (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.readonly

Inputs: locationId (required).

ghl_workflow_update_definitionA
Idempotent

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Update Workflow Definition Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Replace a workflow definition in full. This is a complete overwrite — any step absent from the request is deleted, so always read the current definition first and send it back modified — the definition carries its own version, so sending back what you read keeps you protected against overwriting a concurrent edit. A stale version is rejected with 422 and nothing is written.

Draft only. A published workflow is rejected with 409: the overwrite would replace steps under contacts currently moving through it. Set the workflow to draft with Update Workflow Status, update it, then publish it again.

Order matters. Changing status advances the version, so read the definition after setting the workflow to draft: draft → read → update → publish. Reading first and drafting second leaves you holding a stale version. Endpoint: PUT /workflows/{workflowId}/definition (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.write

Inputs: body (required), locationId (required), workflowId (required).

ghl_workflow_update_statusA
Idempotent

WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Update Workflow Status Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Publish a workflow or send it back to draft. Publishing validates the definition in full and activates the triggers; a definition that fails validation is rejected with 422 and the workflow stays as it was. Locked and scheduled-paused workflows cannot change status and return 409. Endpoint: PUT /workflows/{workflowId}/status (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.publish

Inputs: body (required), locationId (required), workflowId (required).

ghl_workflow_validate_definitionA
Read-onlyIdempotent

Read-only dry validation of a workflow definition — nothing is created or changed. WORKFLOW API — limited availability: enabled for selected sub-accounts only; others get 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION (not a token or scope problem). Suggested order: get step types -> build the definition -> validate (validate_workflow_definition, read-only) -> create (always lands in draft) -> publish via update status. Rate limits: integration daily quota + 10s burst (X-RateLimit-* headers) AND a per-sub-account budget per 10s window with reads and writes counted separately; no Retry-After is sent. Logs: default and max range 30 days; retained 60 days. Validate Workflow Definition Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Run the full save pipeline against a definition and report what a real save would do. Nothing is persisted. Returns 200 with valid: false when the definition is rejected — a 4xx here means the request itself was malformed. Endpoint: POST /workflows/definition/validate (Version header: v3; source: v3/workflows-v3.json) OAuth scopes: workflows.write

Inputs: body (required), locationId (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    C2.9/5.0

    Scored across 855 tools

    Disambiguation2/5

    The descriptions are unusually diligent about flagging distinctions (e.g. 'distinct from ghl_opportunity_search', 'prefer the v3 tool'), but at 855 tools the overlap is structural: every domain carries legacy/deprecated twins (`ghl_saas_*_deprecated` vs `ghl_saas_*`, `ghl_oauth_get_installed_location` vs `..._locations`, `ghl_email_builder_template_*` vs `ghl_email_template_*`, `ghl_agent_studio_*_deprecated`), plus parallel list/search/upsert variants (`ghl_contact_list`/`lookup`/`search_advanced`/`get_duplicate`, `ghl_chat_widget_update` vs `ghl_chat_widget_patch`). An agent can tell most tools apart only by reading long prose, and misselection between near-identical legacy and current operations is highly likely.

    Naming Consistency4/5

    The dominant pattern `ghl_<domain>_<entity>_<action>` in snake_case is followed with impressive discipline across hundreds of tools, including deliberate renames to fix auto-generated artifacts. Minor deviations remain: `ghl_ad_fb_*` abbreviates facebook while other ad tools spell out google/linkedin, verbs mix get/fetch/list within one domain (`ghl_social_get_posts` vs `ghl_social_fetch_queues`), and `_deprecated`/`_legacy` suffixes break the pattern.

    Tool Count1/5

    855 tools for a single server is an extreme mismatch regardless of how broad the underlying GoHighLevel API is. Even though the surface is auto-generated from a large spec, shipping every endpoint (including deprecated and legacy variants) as a flat tool list makes navigation and selection impractical; this needs domain-level scoping or filtering.

    Completeness4/5

    Coverage is effectively exhaustive: contacts, calendars, conversations, invoices, courses, ads, social planner, projects, workflows, SaaS, marketplace all have full CRUD and lifecycle operations. The gaps are individual defects rather than surface holes — `ghl_form_upload_custom_files` has no body schema, and `ghl_user_update`/`ghl_user_delete` are documented as missing their `userId` path parameter.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      B
      quality
      D
      maintenance
      A comprehensive MCP server that connects AI assistants to GoHighLevel CRM, enabling management of contacts, conversations, calendars, pipelines, payments, and more through 60+ tools.
      64
      37 npm
      1
      MIT
    • A
      license
      B
      quality
      D
      maintenance
      MCP server for GoHighLevel API v2 that provides 50+ tools for CRM, billing, marketing, and operations workflows, enabling natural language interaction with contacts, opportunities, conversations, and more.
      50
      1
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      An MCP server for GoHighLevel with 82 live-tested tools, enabling CRM operations like contact management, appointments, invoices, and workflows via natural language.
      Creative Commons Attribution Non Commercial 4.0 International
    • F
      license
      Not graded
      quality
      D
      maintenance
      MCP server for GoHighLevel sub-accounts, enabling management of CRM contacts, pipelines, calendars, invoices, and more via natural language.
      -