ghl_create_ invoiceCreate Invoice API to create an invoice
Search contacts, reply in the inbox, book appointments on a calendar, move opportunities through a pipeline, and raise or send invoices — all inside one sub-account you pick.
PopMCPGoHighLevel
Every read and write the connector exposes across HighLevel's API 2.0, plus the triggers PopMCP can watch — search the grid for what you need.
ghl_create_ invoiceCreate Invoice API to create an invoice
ghl_get_ invoiceGet invoice API to get invoice by invoice id
ghl_list_ invoicesList invoices API to get list of invoices
ghl_record_ invoiceRecord a manual payment for an invoice API to record manual payment for an invoice by invoice id
ghl_send_ invoiceSend invoice API to send invoice by invoice id
ghl_void_ invoiceVoid invoice API to delete invoice by invoice id
ghl_create_ appointmentCreate appointment
ghl_edit_ appointmentUpdate Appointment
ghl_get_ appointmentGet Appointment Get appointment by ID
ghl_get_ calendar_ eventsGet Calendar Events
ghl_get_ calendarsGet Calendars Get all calendars in a location.
ghl_get_ slotsGet Free Slots Get free slots for a calendar between a date range.
ghl_create_ postCreate post Create posts for all supported platforms.
ghl_get_ accountGet Accounts Get list of accounts and groups
ghl_add_ contact_ to_ campaignAdd Contact to Campaign
ghl_add_ contact_ to_ workflowAdd Contact to Workflow
ghl_add_ tagsAdd Tags
ghl_create_ contactCreate Contact
ghl_create_ noteCreate Note
ghl_create_ taskCreate Task
ghl_delete_ contactDelete Contact
ghl_get_ all_ notesGet All Notes
ghl_get_ all_ tasksGet all Tasks
ghl_get_ appointments_ for_ contactGet Appointments for Contact
ghl_get_ contactGet Contact
ghl_remove_ tagsRemove Tags
ghl_search_ contacts_ advancedSearch Contacts Search contacts based on combinations of advanced filters.
ghl_update_ contactUpdate Contact
ghl_update_ task_ completedUpdate Task Completed
ghl_upsert_ contactUpsert Contact
ghl_create_ conversationCreate Conversation Creates a new conversation with the data provided
ghl_create_ tagCreate Tag
ghl_get_ conversationGet Conversation Get the conversation details based on the conversation ID
ghl_get_ custom_ fieldsGet Custom Fields
ghl_get_ custom_ valuesGet Custom Values
ghl_get_ locationGet Sub-Account (Formerly Location) Get details of a Sub-Account (Formerly Location) by passing the sub-account id
ghl_get_ location_ tagsGet Tags Get Sub-Account (Formerly Location) Tags
ghl_get_ messagesGet messages by conversation id Get messages by conversation id.
ghl_search_ conversationSearch Conversations Returns a list of all conversations matching the search criteria along with the sort and filter options selected.
ghl_send_ a_ new_ messageSend a new message Post the necessary fields for the API to send a new message.
ghl_update_ message_ statusUpdate message status Post the necessary fields for the API to update message status.
ghl_create_ productCreate Product The "Create Product" API allows adding a new product to the system.
ghl_get_ productGet Product by ID The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier.
ghl_list_ prices_ for_ productList Prices for a Product The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product.
ghl_list_ productsList Products The "List Products" API allows to retrieve a paginated list of products.
ghl_get_ order_ by_ idGet Order by ID The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier.
ghl_list_ ordersList Orders The "List Orders" API allows to retrieve a paginated list of orders.
ghl_list_ subscriptionsList Subscriptions The "List Subscriptions" API allows to retrieve a paginated list of subscriptions.
ghl_list_ transactionsList Transactions The "List Transactions" API allows to retrieve a paginated list of transactions.
ghl_create_ opportunityCreate Opportunity
ghl_get_ opportunityGet Opportunity
ghl_get_ pipelinesGet Pipelines
ghl_search_ opportunitySearch Opportunity
ghl_update_ opportunityUpdate Opportunity
ghl_update_ opportunity_ statusUpdate Opportunity Status
ghl_upsert_ opportunityUpsert Opportunity
ghl_fetch_ media_ contentGet List of Files/ Folders Fetches list of files and folders from the media storage
ghl_get_ funnelsFetch List of Funnels Retrieves a list of all funnels based on the given query parameters.
ghl_get_ userGet User
ghl_get_ businesses_ by_ locationGet Businesses by Location
ghl_get_ formsGet Forms
ghl_get_ forms_ submissionsGet Forms Submissions
ghl_get_ surveys_ submissionsGet Surveys Submissions
ghl_get_ campaignsGet Campaigns
ghl_get_ workflowGet Workflow
ghl_fb_ add_ custom_ audience_ memberAdd custom audience member Add a member to a Facebook custom audience
ghl_fb_ batch_ update_ audience_ membersBatch update audience members Add or remove members in bulk from a Facebook custom audience via CSV or smart lists
ghl_fb_ create_ conversation_ formCreate conversation form Create a new Facebook conversation lead form
ghl_fb_ create_ integrationCreate Facebook integration Create a Facebook ad integration for a location with page and ad account
ghl_fb_ create_ page_ lead_ formCreate page lead form Create a new lead gen form on a Facebook page
ghl_fb_ delete_ adDelete ad Delete a Facebook ad by ID
ghl_fb_ delete_ ad_ accountDelete ad account Remove a Facebook ad account connection from a location
ghl_fb_ delete_ adsetDelete ad set Delete a Facebook ad set by ID
ghl_fb_ delete_ campaignDelete campaign Delete a Facebook campaign by ID
ghl_fb_ delete_ custom_ audienceDelete custom audience Delete a Facebook custom audience by ID
ghl_fb_ delete_ integrationDelete Facebook integration Remove the Facebook ad integration from a location
ghl_fb_ delete_ pageDelete page connection Remove a Facebook page connection from a location
ghl_fb_ duplicate_ adDuplicate ad Duplicate an existing Facebook ad
ghl_fb_ duplicate_ adsetDuplicate ad set Duplicate an existing Facebook ad set
ghl_fb_ duplicate_ campaignDuplicate campaign Duplicate an existing Facebook campaign
ghl_fb_ get_ ad_ accountGet ad account details Retrieve details of a specific Facebook ad account
ghl_fb_ get_ ad_ accountsGet ad accounts Retrieve Facebook ad accounts available for the connected user
ghl_fb_ get_ campaignGet campaign with linked entities Retrieve a Facebook campaign with its linked adsets and ads
ghl_fb_ get_ campaign_ reportingGet campaign reporting Retrieve reporting metrics for a specific Facebook campaign
ghl_fb_ get_ conversation_ formsGet conversation forms Retrieve Facebook conversation lead forms for a location
ghl_fb_ get_ current_ userGet current Facebook user Retrieve the authenticated Facebook user profile for a location
ghl_fb_ get_ custom_ audience_ by_ idGet custom audience by ID Retrieve a specific Facebook custom audience by its ID
ghl_fb_ get_ custom_ audiencesGet custom audiences Retrieve Facebook custom audiences for a location
ghl_fb_ get_ entityGet entities Retrieve Facebook campaigns, adsets, or ads based on entity type
ghl_fb_ get_ instagram_ accountsGet Instagram accounts for page Retrieve Instagram accounts linked to a specific Facebook page
ghl_fb_ get_ integrationGet Facebook integration Retrieve the Facebook ad integration details for a location
ghl_fb_ get_ lead_ formGet lead form by ID Retrieve a specific Facebook lead form by its ID
ghl_fb_ get_ page_ lead_ formsGet page lead forms Retrieve lead gen forms for a specific Facebook page
ghl_fb_ get_ pagesGet Facebook pages Retrieve Facebook pages associated with the connected account
ghl_fb_ get_ pixelsGet conversion pixels Retrieve Facebook conversion pixels for a location
ghl_fb_ get_ reportingGet reporting data Retrieve aggregated Facebook ad reporting metrics for a location
ghl_fb_ get_ reporting_ listGet reporting list Retrieve a list of Facebook campaigns, adsets, or ads with reporting data
ghl_fb_ pause_ adPause ad Pause a running Facebook ad
ghl_fb_ pause_ adsetPause ad set Pause a running Facebook ad set
ghl_fb_ pause_ campaignPause campaign Pause a running Facebook campaign
ghl_fb_ publish_ campaignPublish campaign Publish a Facebook campaign and push it live to Facebook
ghl_fb_ remove_ custom_ audience_ memberRemove custom audience member Remove a member from a Facebook custom audience
ghl_fb_ resume_ adResume ad Resume a paused Facebook ad
ghl_fb_ resume_ adsetResume ad set Resume a paused Facebook ad set
ghl_fb_ resume_ campaignResume campaign Resume a paused Facebook campaign
ghl_fb_ search_ targetingSearch targeting options Search Facebook geo-locations and interests for ad targeting
ghl_fb_ set_ default_ pageSet default page Set the default Facebook page for a location
ghl_fb_ update_ custom_ audienceUpdate custom audience Update name or description of a Facebook custom audience
ghl_fb_ upsert_ adUpsert ad Create or update a Facebook ad (v2)
ghl_fb_ upsert_ adsetUpsert adset Create or update a Facebook ad set
ghl_fb_ upsert_ campaignUpsert campaign Create or update a Facebook campaign
ghl_fb_ upsert_ pixelUpsert conversion pixel Create or update a Facebook conversion pixel configuration
ghl_google_ create_ integrationCreate Google integration Create a Google Ads integration for a location
ghl_google_ create_ offline_ user_ list_ jobCreate offline user list job Create a job to upload users to a Google customer match list
ghl_google_ delete_ ad_ accountDelete ad account Remove a Google Ads account connection from a location
ghl_google_ delete_ conversionDelete conversion Delete a Google Ads conversion action by ID
ghl_google_ delete_ segmentDelete segment Delete a Google Ads audience segment by ID
ghl_google_ get_ ad_ account_ detailsGet ad account details Retrieve details of a specific Google Ads account
ghl_google_ get_ ad_ accountsGet Google ad accounts Retrieve Google Ads accounts available for the connected user
ghl_google_ get_ assetsGet assets Retrieve Google Ads creative assets for a location
ghl_google_ get_ audience_ by_ idGet audience by ID Retrieve a specific Google Ads combined audience by ID
ghl_google_ get_ audiencesGet audiences Retrieve Google Ads combined audiences for a location
ghl_google_ get_ campaign_ by_ idGet Google campaign by ID Retrieve a specific Google Ads campaign by ID
ghl_google_ get_ campaign_ reportingGet campaign reporting Retrieve reporting metrics for a specific Google campaign
ghl_google_ get_ conversion_ by_ idGet conversion by ID Retrieve a specific Google Ads conversion action by ID
ghl_google_ get_ conversion_ goalsGet conversion goals Retrieve Google Ads conversion goals for a location
ghl_google_ get_ conversionsGet conversions Retrieve Google Ads conversion actions for a location
ghl_google_ get_ current_ userGet current Google user Retrieve the authenticated Google user info for a location
ghl_google_ get_ entityGet entities Retrieve Google campaigns, ad groups, or ads based on entity type
ghl_google_ get_ integrationGet Google integration Retrieve the Google Ads integration details for a location
ghl_google_ get_ keyword_ ideasGet keyword ideas Retrieve keyword suggestions for Google Ads campaigns
ghl_google_ get_ reportingGet reporting data Retrieve aggregated Google Ads reporting metrics for a location
ghl_google_ get_ reporting_ listGet reporting list Retrieve a list of Google campaigns or ad groups with reporting data
ghl_google_ get_ segment_ by_ idGet segment by ID Retrieve a specific Google Ads audience segment by ID
ghl_google_ get_ segmentsGet segments Retrieve Google Ads audience segments for a location
ghl_google_ get_ target_ interestsGet target interests Retrieve affinity and in-market audience options for Google Ads targeting
ghl_google_ publish_ adPublish ad Publish a Google ad and push it live
ghl_google_ search_ targetingSearch targeting options Search Google geo-locations for ad targeting
ghl_google_ upsert_ assetsUpsert assets Create or update Google Ads creative assets
ghl_google_ upsert_ audienceUpsert audience Create or update a Google Ads combined audience
ghl_google_ upsert_ campaignUpsert Google campaign Create or update a full Google Ads campaign structure
ghl_google_ upsert_ conversionUpsert conversion Create or update a Google Ads conversion action
ghl_google_ upsert_ segmentUpsert segment Create or update a Google Ads audience segment
ghl_li_ create_ integrationCreate LinkedIn integration Create a LinkedIn Ads integration for a location with ad account details
ghl_li_ create_ lead_ formCreate lead form Create a new LinkedIn lead gen form for an ad account
ghl_li_ delete_ ad_ accountDelete ad account Remove a LinkedIn ad account connection from a location
ghl_li_ get_ ad_ account_ detailsGet ad account details Retrieve details of a specific LinkedIn ad account
ghl_li_ get_ ad_ accountsGet LinkedIn ad accounts Retrieve LinkedIn Ads accounts available for the connected user
ghl_li_ get_ ad_ analyticsGet ad analytics Retrieve LinkedIn Ads analytics data with configurable pivot and time grouping
ghl_li_ get_ campaign_ groupGet ad campaign group Retrieve a LinkedIn ad campaign group by ID
ghl_li_ get_ campaign_ group_ reportingGet campaign group reporting Retrieve reporting metrics for a specific LinkedIn campaign group
ghl_li_ get_ current_ userGet current LinkedIn user Retrieve the authenticated LinkedIn user info for a location
ghl_li_ get_ integrationGet LinkedIn integration Retrieve the LinkedIn Ads integration details for a location
ghl_li_ get_ lead_ formsGet lead forms Retrieve LinkedIn lead gen forms for an ad account
ghl_li_ get_ reporting_ listGet reporting list Retrieve a list of LinkedIn campaigns or campaign groups with reporting data
ghl_li_ publish_ campaign_ groupPublish ad campaign group Publish a LinkedIn ad campaign group and push it live
ghl_li_ search_ targetingSearch targeting options Search LinkedIn targeting facets such as locations, industries, and job titles
ghl_li_ update_ ad_ statusUpdate ad status Pause or resume a LinkedIn ad, campaign, or ad group
ghl_li_ upsert_ campaign_ groupUpsert ad campaign group Create or update a LinkedIn ad campaign group with campaigns and ads
ghl_auto_ payment_ invoice_ scheduleManage Auto payment for an schedule invoice API to manage auto payment for a schedule
ghl_cancel_ invoice_ scheduleCancel an scheduled invoice API to cancel a scheduled invoice by schedule id
ghl_create_ estimate_ templateCreate Estimate Template Create a new estimate template
ghl_create_ invoice_ from_ estimateCreate Invoice from Estimate Create a new invoice from an existing estimate
ghl_create_ invoice_ scheduleCreate Invoice Schedule API to create an invoice Schedule
ghl_create_ invoice_ templateCreate template API to create a template
ghl_create_ new_ estimateCreate New Estimate Create a new estimate with the provided details
ghl_delete_ estimateDelete Estimate Delete an existing estimate
ghl_delete_ estimate_ templateDelete Estimate Template Delete an existing estimate template
ghl_delete_ invoiceDelete invoice API to delete invoice by invoice id
ghl_delete_ invoice_ scheduleDelete schedule API to delete an schedule by schedule id
ghl_delete_ invoice_ templateDelete template API to update an template by template id
ghl_generate_ estimate_ numberGenerate Estimate Number Get the next estimate number for the given location
ghl_generate_ invoice_ numberGenerate Invoice Number Get the next invoice number for the given location
ghl_get_ invoice_ scheduleGet an schedule API to get an schedule by schedule id
ghl_get_ invoice_ settingsGet Invoice Settings Get the invoice settings for the given location
ghl_get_ invoice_ templateGet an template API to get an template by template id
ghl_list_ estimate_ templatesList Estimate Templates Get a list of estimate templates or a specific template by ID
ghl_list_ estimatesList Estimates Get a paginated list of estimates
ghl_list_ invoice_ schedulesList schedules API to get list of schedules
ghl_list_ invoice_ templatesList templates API to get list of templates
ghl_preview_ estimate_ templatePreview Estimate Template Get a preview of an estimate template
ghl_schedule_ invoice_ scheduleSchedule an schedule invoice API to schedule an schedule invoice to start sending to the customer
ghl_send_ estimateSend Estimate API to send estimate by estimate id
ghl_text2pay_ invoiceCreate & Send API to create or update a text2pay invoice
ghl_update_ and_ schedule_ invoice_ scheduleUpdate scheduled recurring invoice API to update scheduled recurring invoice
ghl_update_ estimateUpdate Estimate Update an existing estimate with new details
ghl_update_ estimate_ last_ visited_ atUpdate estimate last visited at API to update estimate last visited at by estimate id
ghl_update_ estimate_ templateUpdate Estimate Template Update an existing estimate template
ghl_update_ invoiceUpdate invoice API to update invoice by invoice id
ghl_update_ invoice_ last_ visited_ atUpdate invoice last visited at API to update invoice last visited at by invoice id
ghl_update_ invoice_ late_ fees_ configurationUpdate invoice late fees configuration API to update invoice late fees configuration by invoice id
ghl_update_ invoice_ payment_ methods_ configurationUpdate template late fees configuration API to update template late fees configuration by template id
ghl_update_ invoice_ scheduleUpdate schedule API to update an schedule by schedule id
ghl_update_ invoice_ templateUpdate template API to update an template by template id
ghl_update_ invoice_ template_ late_ fees_ configurationUpdate template late fees configuration API to update template late fees configuration by template id
ghl_add_ calendar_ to_ scheduleApply user availability schedule to a calendar Associates a calendar with the given schedule by adding the calendarId to a schedule
ghl_create_ appointment_ noteCreate Note
ghl_create_ block_ slotCreate Block Slot
ghl_create_ calendarCreate Calendar Create calendar in a location.
ghl_create_ calendar_ groupCreate Calendar Group
ghl_create_ calendar_ resourceCreate Calendar Resource Create calendar resource by resource type
ghl_create_ event_ notificationCreate notification Create Calendar notifications, either one or multiple.
ghl_create_ scheduleCreate user availability schedule Create new schedule with specified rules, timezone, location, user and calendar associations.
ghl_delete_ appointment_ noteDelete Note
ghl_delete_ calendarDelete Calendar Delete calendar by ID
ghl_delete_ calendar_ resourceDelete Calendar Resource Delete calendar resource by ID
ghl_delete_ eventDelete Event Delete event by ID
ghl_delete_ event_ notificationDelete Notification
ghl_delete_ groupDelete Group
ghl_delete_ scheduleDelete user availability schedule Permanently remove a schedule and all its associated rules.
ghl_disable_ groupDisable Group
ghl_edit_ block_ slotUpdate Block Slot Update block slot by ID
ghl_edit_ groupUpdate Group Update Group by group ID
ghl_fetch_ calendar_ resourcesList Calendar Resources List calendar resources by resource type and location ID
ghl_find_ event_ notificationGet notification Find Event notification by notificationId
ghl_get_ all_ schedulesList user availability schedule Retrieve user availability schedules based on various filters including location, calendar, and user.
ghl_get_ appointment_ notesGet Notes Get Appointment Notes
ghl_get_ blocked_ slotsGet Blocked Slots
ghl_get_ calendarGet Calendar Get calendar by ID
ghl_get_ calendar_ resourceGet Calendar Resource Get calendar resource by ID
ghl_get_ event_ notificationGet notifications Get calendar notifications based on query
ghl_get_ groupsGet Groups Get all calendar groups in a location.
ghl_get_ schedule_ by_ idGet user availability schedule Retrieve a specific schedule by its unique identifier.
ghl_remove_ calendar_ from_ scheduleRemove user availability schedule from a calendar Removes the association between a team calendar and the given schedule by removing the calendarId from the schedule
ghl_update_ appointment_ noteUpdate Note
ghl_update_ calendarUpdate Calendar Update calendar by ID.
ghl_update_ calendar_ resourceUpdate Calendar Resource Update calendar resource by ID
ghl_update_ event_ notificationUpdate notification Update Event notification by id
ghl_update_ scheduleUpdate user availability schedule Modify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated.
ghl_validate_ groups_ slugValidate group slug Validate if group slug is available or not.
ghl_attach_ facebook_ page_ groupAttach facebook pages
ghl_attach_ instagram_ page_ groupAttach Instagram Professional Accounts
ghl_attach_ linkedin_ page_ profileAttach linkedin pages and profile
ghl_attach_ tiktok_ profileAttach Tiktok profile
ghl_bulk_ delete_ social_ planner_ postsBulk Delete Social Planner Posts Deletes multiple posts based on the provided list of post IDs.
ghl_delete_ accountDelete Account Delete account and account from group
ghl_delete_ csvDelete CSV
ghl_delete_ csv_ postDelete CSV Post
ghl_delete_ postDelete Post
ghl_edit_ postEdit post Create posts for all supported platforms.
ghl_get_ categories_ idGet categories by id
ghl_get_ categories_ location_ idGet categories by location id
ghl_get_ csv_ postGet CSV Post
ghl_get_ facebook_ page_ groupGet facebook pages
ghl_get_ google_ locationsGet google business locations
ghl_get_ instagram_ page_ groupGet Instagram Professional Accounts
ghl_get_ linkedin_ page_ profileGet Linkedin pages and profile
ghl_get_ postGet post
ghl_get_ social_ media_ statisticsGet Social Media Statistics Retrieve analytics data for multiple social media accounts.
ghl_get_ tags_ by_ idsGet tags by ids
ghl_get_ tags_ location_ idGet tags by location id
ghl_get_ tiktok_ business_ profileGet Tiktok Business profile
ghl_get_ tiktok_ profileGet Tiktok profile
ghl_get_ upload_ statusGet Upload Status
ghl_list_ social_ postsGet posts
ghl_set_ accountsSet Accounts
ghl_set_ google_ locationsSet google business locations
ghl_start_ csv_ finalizeStart CSV Finalize
ghl_start_ facebook_ oauthStarts OAuth For Facebook Account Open the API in a window with appropriate params and headers instead of using the Curl.
ghl_start_ google_ oauthStarts OAuth For Google Account Open the API in a window with appropriate params and headers instead of using the Curl.
ghl_start_ instagram_ oauthStarts OAuth For Instagram Account Open the API in a window with appropriate params and headers instead of using the Curl.
ghl_start_ linkedin_ oauthStarts OAuth For LinkedIn Account Open the API in a window with appropriate params and headers instead of using the Curl.
ghl_start_ tiktok_ business_ oauthStarts OAuth For Tiktok Business Account Open the API in a window with appropriate params and headers instead of using the Curl.
ghl_start_ tiktok_ oauthStarts OAuth For Tiktok Account Open the API in a window with appropriate params and headers instead of using the Curl.
ghl_upload_ csvUpload CSV
ghl_add_ followers_ contactAdd Followers
ghl_add_ remove_ contact_ from_ businessAdd/Remove Contacts From Business Add/Remove Contacts From Business .
ghl_bulk_ update_ contact_ tagsUpdate Contacts Tags Allows you to update tags to multiple contacts at once, you can add or remove tags from the contacts
ghl_delete_ contact_ from_ workflowDelete Contact from Workflow
ghl_delete_ noteDelete Note
ghl_delete_ taskDelete Task
ghl_get_ contacts_ by_ business_ idGet Contacts By BusinessId
ghl_get_ duplicate_ contactGet Duplicate Contact Get Duplicate Contact.If `Allow Duplicate Contact` is disabled under Settings, the global unique identifier will be used for searching the contact.
ghl_get_ noteGet Note
ghl_get_ taskGet Task
ghl_remove_ contact_ from_ campaignRemove Contact From Campaign
ghl_remove_ contact_ from_ every_ campaignRemove Contact From Every Campaign
ghl_remove_ followers_ contactRemove Followers
ghl_update_ noteUpdate Note
ghl_update_ taskUpdate Task
ghl_add_ an_ inbound_ messageAdd an inbound message Post the necessary fields for the API to add a new inbound message.
ghl_add_ an_ outbound_ messageAdd an external outbound call Post the necessary fields for the API to add a new outbound call.
ghl_add_ message_ attachmentsAdd message attachments Set attachments on an existing message (replaces existing).
ghl_cancel_ scheduled_ email_ messageCancel a scheduled email message.
ghl_cancel_ scheduled_ messageCancel a scheduled message.
ghl_complete_ file_ uploadComplete file upload Validates the uploaded file in GCS and returns the public URL.
ghl_create_ custom_ subtypeCreate Custom Subtype Create a new custom subtype for a location.
ghl_create_ custom_ valueCreate Custom Value
ghl_create_ locationCreate Sub-Account (Formerly Location) Create a new Sub-Account (Formerly Location) based on the data provided ! This feature is only available on Agency Pro ($497) plan.
ghl_create_ recurring_ taskCreate Recurring Task
ghl_delete_ an_ email_ sms_ templateDELETE an email/sms template
ghl_delete_ conversationDelete Conversation Delete the conversation details based on the conversation ID
ghl_delete_ custom_ valueDelete Custom Value
ghl_delete_ locationDelete Sub-Account (Formerly Location) Delete a Sub-Account (Formerly Location) from the Agency
ghl_delete_ recurring_ taskDelete Recurring Task
ghl_delete_ tagDelete tag
ghl_download_ message_ transcriptionDownload transcription by Message ID Download the recording transcription for a message by passing the message id
ghl_export_ messages_ by_ locationExport messages by location ID Export messages for a specific location with cursor-based pagination support.
ghl_get_ all_ custom_ subtypesGet All Custom Subtypes Get all custom subtypes for a location
ghl_get_ all_ or_ email_ sms_ templatesGET all or email/sms templates
ghl_get_ contact_ unsubscription_ statusGet Contact Unsubscription Status Get all subscription statuses for a contact (all emails or specific email)
ghl_get_ custom_ fieldGet Custom Field
ghl_get_ custom_ valueGet Custom Value
ghl_get_ email_ by_ idGet email by Id
ghl_get_ messageGet message by message id Get message by message id.
ghl_get_ message_ recordingGet Recording by Message ID Get the recording for a message by passing the message id
ghl_get_ message_ transcriptionGet transcription by Message ID Get the recording transcription for a message by passing the message id
ghl_get_ recurring_ task_ by_ idGet Recurring Task By Id
ghl_get_ tag_ by_ idGet tag by id
ghl_get_ timezonesFetch Timezones Fetch the available timezones
ghl_initiate_ file_ uploadInitiate file upload to GCS Generates a signed URL for direct file upload to Google Cloud Storage.
ghl_live_ chat_ agent_ typingAgent/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
ghl_locations_ create_ custom_ fieldCreate Custom Field
ghl_locations_ delete_ custom_ fieldDelete Custom Field
ghl_locations_ update_ custom_ fieldUpdate Custom Field
ghl_put_ locationPut Sub-Account (Formerly Location) Update a Sub-Account (Formerly Location) based on the data provided
ghl_search_ locationsSearch Search Sub-Account (Formerly Location)
ghl_send_ review_ replySend a review reply to Google My Business Post a reply to a customer review on Google My Business
ghl_task_ searchTask Search Filter Task Search
ghl_update_ conversationUpdate Conversation Update the conversation details based on the conversation ID
ghl_update_ custom_ subtypeUpdate Custom Subtype Update or archive a custom subtype.
ghl_update_ custom_ valueUpdate Custom Value
ghl_update_ recurring_ taskUpdate Recurring Task
ghl_update_ tagUpdate tag
ghl_upload_ file_ attachmentsUpload file attachments Post the necessary fields for the API to upload files.
ghl_upload_ file_ custom_ fieldsUploads File to customFields
ghl_user_ subscription_ changeUser Subscription Change Process subscription change initiated by an user (admin/agent).
ghl_bulk_ editBulk Edit Products and Prices API to bulk edit products and their associated prices (max 30 entities)
ghl_bulk_ updateBulk Update Products API to bulk update products (price, availability, collections, delete)
ghl_bulk_ update_ product_ reviewUpdate Product Reviews Update one or multiple product reviews: status, reply, etc.
ghl_create_ price_ for_ productCreate Price for a Product The "Create Price for a Product" API allows adding a new price associated with a specific product to the system.
ghl_create_ product_ collectionCreate Product Collection Create a new Product Collection for a specific location
ghl_delete_ price_ by_ id_ for_ productDelete 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.
ghl_delete_ product_ by_ idDelete Product by ID The "Delete Product by ID" API allows deleting a specific product using its unique identifier.
ghl_delete_ product_ collectionDelete Product Collection Delete specific product collection with Id :collectionId
ghl_delete_ product_ reviewDelete Product Review Delete specific product review
ghl_get_ list_ inventoryList Inventory The "List Inventory API allows the user to retrieve a paginated list of inventory items.
ghl_get_ price_ by_ id_ for_ productGet 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.
ghl_get_ product_ collectionFetch Product Collections Internal API to fetch the Product Collections
ghl_get_ product_ collection_ idGet Details about individual product collection
ghl_get_ product_ reviewsFetch Product Reviews API to fetch the Product Reviews
ghl_get_ product_ store_ statsFetch Product Store Stats API to fetch the total number of products, included in the store, and excluded from the store and other stats
ghl_get_ reviews_ countFetch Review Count as per status API to fetch the Review Count as per status
ghl_update_ display_ priorityUpdate product display priorities in store API to set the display priority of products in a store
ghl_update_ inventoryUpdate Inventory The Update Inventory API allows the user to bulk update the inventory for multiple items.
ghl_update_ price_ by_ id_ for_ productUpdate 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.
ghl_update_ product_ by_ idUpdate Product by ID The "Update Product by ID" API allows modifying information for a specific product using its unique identifier.
ghl_update_ product_ collectionUpdate Product Collection Update a specific product collection with Id :collectionId
ghl_update_ product_ reviewUpdate Product Reviews Update status, reply, etc of a particular review
ghl_update_ store_ statusAction to include/exclude the product in store API to update the status of products in a particular store
ghl_create_ configCreate new provider config API to create a new payment config for given location
ghl_create_ couponCreate 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.
ghl_create_ integrationCreate new integration API to create a new association for an app and location
ghl_create_ integration_ providerCreate 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.
ghl_create_ order_ fulfillmentCreate order fulfillment The "Order Fulfillment" API facilitates the process of fulfilling an order.
ghl_custom_ provider_ marketplace_ app_ update_ capabilitiesCustom-provider marketplace app update capabilities Toggle capabilities for the marketplace app tied to the OAuth client
ghl_delete_ couponDelete Coupon The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier.
ghl_delete_ integrationDeleting an existing integration API to delete an association for an app and location
ghl_disconnect_ configDisconnect existing provider config API to disconnect an existing payment config for given location
ghl_fetch_ configFetch given provider config API for fetching an existing payment config for given location
ghl_get_ couponFetch Coupon The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code.
ghl_get_ subscription_ by_ idGet Subscription by ID The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier.
ghl_get_ transaction_ by_ idGet Transaction by ID The "Get Transaction by ID" API allows to retrieve information for a specific transaction using its unique identifier.
ghl_list_ couponsList Coupons The "List Coupons" API allows you to retrieve a list of all coupons available in your location.
ghl_list_ integration_ providersList White-label Integration Providers The "List White-label Integration Providers" API allows to retrieve a paginated list of integration providers.
ghl_list_ order_ fulfillmentList fulfillment List all fulfillment history of an order
ghl_list_ order_ notesList Order Notes List all notes of an order
ghl_record_ order_ paymentRecord Order Payment The "Record Order Payment" API allows to record a payment for an order.
ghl_update_ couponUpdate Coupon The "Update Coupon" API enables you to modify existing coupon details such as discount values, validity periods, usage limits, and other promotional parameters.
ghl_create_ shipping_ carrierCreate Shipping Carrier The "Create Shipping Carrier" API allows adding a new shipping carrier.
ghl_create_ shipping_ rateCreate Shipping Rate The "Create Shipping Rate" API allows adding a new shipping rate.
ghl_create_ shipping_ zoneCreate Shipping Zone The "Create Shipping Zone" API allows adding a new shipping zone.
ghl_create_ store_ settingCreate/Update Store Settings Create or update store settings by altId and altType.
ghl_delete_ shipping_ carrierDelete shipping carrier Delete specific shipping carrier with Id :shippingCarrierId
ghl_delete_ shipping_ rateDelete shipping rate Delete specific shipping rate with Id :shippingRateId
ghl_delete_ shipping_ zoneDelete shipping zone Delete specific shipping zone with Id :shippingZoneId
ghl_get_ available_ shipping_ zonesGet available shipping rates This return available shipping rates for country based on order amount
ghl_get_ shipping_ carriersGet Shipping Carrier The "List Shipping Carrier" API allows to retrieve a paginated list of shipping carrier.
ghl_get_ shipping_ ratesGet Shipping Rate The "List Shipping Rate" API allows to retrieve a paginated list of shipping rate.
ghl_get_ shipping_ zonesGet Shipping Zone The "List Shipping Zone" API allows to retrieve a paginated list of shipping zone.
ghl_get_ store_ settingsGet Store Settings Get store settings by altId and altType.
ghl_list_ shipping_ carriersList Shipping Carriers The "List Shipping Carrier" API allows to retrieve a list of shipping carrier.
ghl_list_ shipping_ ratesList Shipping Rates The "List Shipping Rate" API allows to retrieve a list of shipping rate.
ghl_list_ shipping_ zonesList Shipping Zones The "List Shipping Zone" API allows to retrieve a list of shipping zone.
ghl_update_ shipping_ carrierUpdate Shipping Carrier The "update Shipping Carrier" API allows update a shipping carrier to the system.
ghl_update_ shipping_ rateUpdate Shipping Rate The "update Shipping Rate" API allows update a shipping rate to the system.
ghl_update_ shipping_ zoneUpdate Shipping Zone The "update Shipping Zone" API allows update a shipping zone to the system.
ghl_createCreate a new FAQ inside knowledge base
ghl_create_ knowledge_ baseCreate a new knowledge base (max 15 knowledge bases per location)
ghl_deleteDelete an existing knowledge base FAQ
ghl_delete_ knowledge_ baseDelete a knowledge base
ghl_delete_ trained_ urls_ for_ knowledge_ baseDelete trained pages
ghl_discover_ websiteStart crawling and discover pages for training
ghl_get_ all_ website_ urls_ data_ by_ knowledge_ baseGet all trained page links by knowledge base
ghl_get_ crawling_ status_ for_ latest_ operationGet crawling status for the latest operation
ghl_get_ knowledge_ base_ by_ idGet knowledge base by ID
ghl_listGet all FAQs by knowledge base with pagination support Retrieves FAQs for a knowledge base.
ghl_list_ all_ knowledge_ bases_ paginatedGet all knowledge bases for a location by location Id (paginated)
ghl_train_ discovered_ urlsTrain discovered website pages and ingest into the knowledge base
ghl_updateUpdate an existing knowledge base FAQ
ghl_update_ knowledge_ baseUpdate a knowledge base
ghl_add_ followers_ opportunityAdd Followers
ghl_convai_ create_ actionAttach Action to Agent Creates and attach a new action for an AI agent.
ghl_convai_ create_ agentCreate an Agent Creates a new AI agent for the location.
ghl_convai_ delete_ actionRemove Action from Agent Permanently deletes an action.
ghl_convai_ delete_ agentDelete Agent Deletes an AI agent permanently.
ghl_convai_ get_ agentGet Agent Retrieves a specific AI agent by its ID.
ghl_convai_ update_ actionUpdate Action Updates an existing action's configuration.
ghl_delete_ opportunityDelete Opportunity
ghl_get_ action_ by_ idGet Action by ID Retrieves detailed information about a specific action using its unique identifier.
ghl_get_ generation_ detailsGet the generation details Retrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks, and Rich Text chunks.
ghl_get_ lost_ reasonGet lost reason
ghl_list_ actionsList Actions for an Agent List for actions for an agent
ghl_remove_ followers_ opportunityRemove Followers Allows removal of one or all followers from an opportunity.
ghl_search_ agentSearch Agents Searches for AI agents based on various criteria including name, status, and configuration.
ghl_search_ opportunities_ advancedSearch Opportunities Search Opportunities based on combinations of advanced filters.
ghl_update_ agentUpdate Agent Updates an existing AI agent's configuration.
ghl_update_ followup_ settingsUpdate Followup Settings Update the followup settings for an action
ghl_bulk_ disable_ saasDisable SaaS for locations Disable SaaS for locations for given locationIds
ghl_bulk_ enable_ saasBulk Enable SaaS Enable SaaS mode for multiple locations with support for both SaaS v1 and v2
ghl_enable_ saas_ locationEnable SaaS for Sub-Account (Formerly Location) Enable SaaS for Sub-Account (Formerly Location) based on the data provided ! This feature is only available on Agency Pro ($497) plan.
ghl_generate_ payment_ linkUpdate SaaS subscription Update SaaS subscription for given locationId and customerId
ghl_get_ actionGet Agent Action Retrieve details of a specific action by its ID.
ghl_get_ agency_ plansGet Agency Plans Fetch all agency subscription plans for a given company ID
ghl_get_ call_ logGet Call Log Returns a call log by callId.
ghl_get_ call_ logsList Call Logs Returns call logs for Voice AI agents scoped to a location.
ghl_get_ location_ subscriptionGet Location Subscription Details Fetch subscription details for a specific location from location metadata
ghl_get_ saas_ locationsGet SaaS Locations Fetch all SaaS-activated locations for a company with pagination
ghl_get_ saas_ planGet SaaS Plan Fetch a specific SaaS plan by plan ID
ghl_locationsGet locations by stripeId with companyId Get locations by stripeCustomerId or stripeSubscriptionId with companyId
ghl_patch_ agentPatch Agent Partially update an existing voice AI agent
ghl_pause_ locationPause location Pause Sub account for given locationId
ghl_update_ rebillingUpdate Rebilling Bulk update rebilling for given locationIds
ghl_voice_ create_ actionCreate Agent Action Create a new action for a voice AI agent.
ghl_voice_ create_ agentCreate Agent Create a new voice AI agent configuration and settings
ghl_voice_ delete_ actionDelete Agent Action Delete an existing action from a voice AI agent.
ghl_voice_ delete_ agentDelete Agent Delete a voice AI agent and all its configurations
ghl_voice_ get_ agentGet Agent Retrieve detailed configuration and settings for a specific voice AI agent
ghl_voice_ get_ agentsList Agents Retrieve a paginated list of agents for given location.
ghl_voice_ update_ actionUpdate Agent Action Update an existing action for a voice AI agent.
ghl_create_ associationCreate Association Allow you to create contact - contact , contact - custom objects associations, will add more in the future.
ghl_create_ relationCreate Relation for you associated entities.
ghl_delete_ associationDelete Association Delete USER_DEFINED Association By Id, deleting an association will also all the relations for that association
ghl_delete_ relationDelete Relation
ghl_find_ associationsGet all associations for a sub-account / location Get all Associations
ghl_get_ association_ by_ idGet association by ID Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id
ghl_get_ association_ by_ object_ keysGet association by object keys Get association by object keys like contacts, custom objects and opportunities.
ghl_get_ association_ key_ by_ key_ nameGet association key by key name Using this api you can get standard / user defined association by key
ghl_get_ relations_ by_ record_ idGet all relations By record Id
ghl_update_ associationUpdate Association By Id Update Association , Allows you to update labels of an associations.
ghl_chargeCreate a new wallet charge
ghl_create_ custom_ object_ schemaCreate Custom Object Allows you to create a custom object schema.
ghl_create_ object_ recordCreate Record Create a Custom Object Record.
ghl_delete_ chargeDelete a wallet charge
ghl_delete_ object_ recordDelete Record Delete Record By Id .
ghl_get_ chargesGet all wallet charges
ghl_get_ installer_ detailsGet Installer Details Fetches installer details for the authenticated user.
ghl_get_ object_ by_ location_ idGet all objects for a location Get all objects for a location.
ghl_get_ object_ schema_ by_ keyGet Object Schema by key / id Retrieve Object Schema by key or ID.
ghl_get_ rebilling_ config_ for_ appGet rebilling config for an app subscription and usage plans Get rebilling config for an app subscription and usage plans for the authenticated sub-account.
ghl_get_ record_ by_ idGet Record By Id Allows you to get a Standard Object like business and custom object record by Id
ghl_get_ specific_ chargeGet specific wallet charge details
ghl_has_ fundsCheck if account has sufficient funds
ghl_migrate_ connectionMigrate external authentication connection Migrates an external authentication connection credentials (basic or oauth2) for a specific app and location.
ghl_search_ object_ recordsSearch Object Records Supported Objects are custom objects and standard objects like "business".
ghl_uninstall_ applicationUninstall an application Uninstalls an application from your company or a specific location.
ghl_update_ custom_ objectUpdate Object Schema By Key / Id Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields.
ghl_update_ object_ recordUpdate Record Update a Custom Object Record by Id.
ghl_agent_ create_ agentCreate Agent Creates a new agent with staging version.
ghl_agent_ delete_ agentDelete Agent Deletes an agent and all its versions.
ghl_agent_ get_ agentsList Agents Lists all active agents for the specified location.
ghl_cf_ create_ custom_ fieldCreate Custom Field Create Custom Field ! Only supports Custom Objects and Company (Business) today.
ghl_cf_ delete_ custom_ fieldDelete Custom Field By Id Delete Custom Field By Id ! Only supports Custom Objects and Company (Business) today.
ghl_cf_ update_ custom_ fieldUpdate Custom Field By Id Update Custom Field By Id ! Only supports Custom Objects and Company (Business) today.
ghl_create_ custom_ field_ folderCreate Custom Field Folder Create Custom Field Folder ! Only supports Custom Objects and Company (Business) today.
ghl_delete_ custom_ field_ folderDelete Custom Field Folder Create Custom Field Folder ! Only supports Custom Objects and Company (Business) today.
ghl_execute_ agentExecute Agent Executes the specified agent and returns a non-streaming JSON response with the complete agent output.
ghl_get_ agent_ by_ idGet Agent Gets a specific agent by its ID for the specified location with all its versions.
ghl_get_ custom_ field_ by_ idGet Custom Field / Folder By Id Get Custom Field / Folder By Id.
ghl_get_ custom_ fields_ by_ object_ keyGet Custom Fields By Object Key Get Custom Fields By Object Key ! Only supports Custom Objects and Company (Business) today.
ghl_promote_ and_ publishPromote to Production Promotes a draft version to production.
ghl_update_ agent_ metadataUpdate Agent Metadata Updates agent metadata such as name, description, and status.
ghl_update_ agent_ versionUpdate Agent Updates a specific agent version by versionId.
ghl_update_ custom_ field_ folderUpdate Custom Field Folder Name Create Custom Field Folder ! Only supports Custom Objects and Company (Business) today.
ghl_bulk_ delete_ media_ objectsBulk Delete / Trash Files or Folders Soft-deletes or trashes multiple files and folders in a single request
ghl_bulk_ update_ media_ objectsBulk Update Files/ Folders Updates metadata or status of multiple files and folders
ghl_check_ url_ slug_ existsCheck url slug The "Check url slug" API allows check the blog slug validation which is needed before publishing any blog post.
ghl_create_ blog_ postCreate Blog Post The "Create Blog Post" API allows you create blog post for any given blog site.
ghl_create_ media_ folderCreate Folder Creates a new folder in the media storage
ghl_create_ redirectCreate Redirect The "Create Redirect" API Allows adding a new url redirect to the system.
ghl_delete_ media_ contentDelete File or Folder Deletes specific file or folder from the media storage
ghl_delete_ redirect_ by_ idDelete Redirect By Id The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system using its unique identifier.
ghl_fetch_ redirects_ listFetch List of Redirects Retrieves a list of all URL redirects based on the given query parameters.
ghl_get_ all_ blog_ authors_ by_ locationGet all authors The "Get all authors" Api return the blog authors for a given location ID.
ghl_get_ all_ categories_ by_ locationGet all categories The "Get all categories" Api return the blog categoies for a given location ID.
ghl_get_ blog_ postGet Blog posts by Blog ID The "Get Blog posts by Blog ID" API allows you get blog posts for any given blog site using blog ID.Please use blogs/posts.readonly
ghl_get_ blogsGet Blogs by Location ID The "Get Blogs by Location ID" API allows you get blogs using Location ID.Please use blogs/list.readonly
ghl_get_ pages_ by_ funnel_ idFetch list of funnel pages Retrieves a list of all funnel pages based on the given query parameters.
ghl_get_ pages_ count_ by_ funnel_ idFetch count of funnel pages Retrieves count of all funnel pages based on the given query parameters.
ghl_update_ blog_ postUpdate Blog Post The "Update Blog Post" API allows you update blog post for any given blog site.
ghl_update_ media_ objectUpdate File/ Folder Updates a single file or folder by ID
ghl_update_ redirect_ by_ idUpdate Redirect By Id The "Update Redirect By Id" API Allows updating an existing URL redirect in the system.
ghl_upload_ media_ contentUpload File into Media Storage If hosted is set to true then fileUrl is required.
ghl_create_ linkCreate Link
ghl_create_ userCreate User
ghl_delete_ linkDelete Link
ghl_delete_ userDelete User
ghl_filter_ users_ by_ emailFilter Users by Email Filter users by company ID, deleted status, and email array
ghl_get_ link_ by_ idGet Link by ID Get a single link by its ID
ghl_get_ linksGet Links
ghl_search_ trigger_ linksSearch Trigger Links Get list of links by searching
ghl_search_ usersSearch Users
ghl_update_ linkUpdate Link
ghl_update_ userUpdate User
ghl_create_ brand_ boardCreate a new brand board Creates a new brand board with logos, colors, and fonts
ghl_create_ businessCreate Business
ghl_create_ custom_ menuCreate Custom Menu Link Creates a new custom menu for a company.
ghl_create_ templateCreate a new template
ghl_delete_ brand_ boardDelete a Brand Board Deletes a Brand Board
ghl_delete_ businessDelete Business
ghl_delete_ custom_ menuDelete Custom Menu Link Removes a specific custom menu from the system.
ghl_delete_ templateDelete a template
ghl_fetch_ campaignsGet Campaigns
ghl_fetch_ templateFetch email templates Fetch email templates by location id
ghl_get_ brand_ board_ by_ idGet Brand Board Retrieves a specific Brand Board by its ID
ghl_get_ brand_ boards_ by_ locationGet Brand Boards Retrieves all Brand Boards for a specific location
ghl_get_ businessGet Business
ghl_get_ custom_ menu_ by_ idGet Custom Menu Link Fetches a single custom menus based on id.
ghl_get_ custom_ menusGet Custom Menu Links Fetches a collection of custom menus based on specified criteria.
ghl_update_ brand_ boardUpdate a Brand Board Updates an existing Brand Board
ghl_update_ businessUpdate Business
ghl_update_ custom_ menuUpdate Custom Menu Link Updates an existing custom menu for a given company.
ghl_update_ templateUpdate a template
ghl_active_ numbersList active numbers Retrieve a paginated list of active phone numbers for a specific location.
ghl_available_ numbersList available phone numbers Search for available phone numbers to purchase for a specific location.
ghl_create_ snapshot_ share_ linkCreate Snapshot Share Link Create a share link for snapshot
ghl_get_ affiliateGet Affiliate Retrieve a single affiliate by id for a location.
ghl_get_ custom_ snapshotsGet Snapshots Get a list of all own and imported Snapshots
ghl_get_ latest_ snapshot_ pushGet Last Snapshot Push Get Latest Snapshot Push Status for a location id
ghl_get_ number_ pool_ listList Number Pools Get list of number pools
ghl_get_ snapshot_ pushGet Snapshot Push between Dates Get list of sub-accounts snapshot pushed in time period
ghl_list_ affiliatesList Affiliates Retrieve the list of affiliates for a location.
ghl_list_ commissionsList Commissions Retrieve the list of commissions for a location.
ghl_list_ documents_ contractsList documents List documents for a location
ghl_list_ documents_ contracts_ templatesList templates List document contract templates for a location
ghl_list_ payoutsList Payouts Retrieve the list of payouts for a location.
ghl_purchase_ phone_ numberPurchase a phone number Purchase a phone number for a specific location.
ghl_send_ documents_ contractsSend document Send document to a client
ghl_send_ documents_ contracts_ templateSend template Send template to a client
ghl_get_ access_ tokenGet Access Token Use Access Tokens to access GoHighLevel resources on behalf of an authenticated location/company.
ghl_get_ installed_ locationGet Location where app is installed This API allows you fetch location where app is installed upon
ghl_get_ location_ access_ tokenGet Location Access Token from Agency Token This API allows you to generate locationAccessToken from AgencyAccessToken
ghl_upload_ to_ custom_ fieldsUpload files to custom fields Post the necessary fields for the API to upload files.
ghl_get_ surveysGet Surveys
ghl_get_ companyGet Company Get Comapny
ghl_import_ coursesImport Courses Import Courses through public channels
ghl_verify_ emailEmail Verification Verify Email
Credentials off one GoHighLevel screen, then an endpoint your client signs into. Nothing to deploy, and nothing to install.
In HighLevel, open Settings → Private Integrations, create a token with the scopes the AI should use, and paste it as Private Integration Token. Your sub-account id goes in Location ID — every call is scoped there.
••••••••••••3f7ave9EPM428h8vShlRW1KTRead-only suits reporting. For full access, keep approval on writes so nothing reaches a customer — a message, a sent or voided invoice, a published post — without your sign-off. The full catalog toggle adds the rest.
Drop the PopMCP URL into Claude, ChatGPT, Codex or any other supported client. It signs in through PopMCP with OAuth, so your GoHighLevel credential never leaves the server.
app.popmcp.com/mcp/…Ask for something harmless before you turn writes on. Once it comes back clean, widen the tool set or switch the connection to full access.
List last month's unpaid invoices and the contact behind each one
ghl_list_invoicesok
Then just ask for the work
“List last month's unpaid invoices and the contact behind each one”
“Tag every contact who booked an appointment this week as warm-lead”
“Book Priya into the free 2pm slot Thursday and note why she called”
“Did anyone who messaged us on SMS yesterday already have an open invoice”
One hosted endpoint, registered once per client. The same tools and the same permissions, whichever window the request comes from.
Add the PopMCP URL under Settings → Connectors and the tools appear in every chat.
The same endpoint, registered in the browser. Nothing to install on the machine you are working from.
Register PopMCP as a custom connector, then let ChatGPT read and update the account.
Wire the endpoint into Codex or the Codex CLI when a task needs live business context, not a fixture.
Register the remote MCP server in OpenCode's config for terminal-first and scripted agent runs.
Add PopMCP as an MCP server in Z.ai's desktop app and work the account from the same window.
FAQ
What teams ask before putting GoHighLevel behind an AI client.
No. You create a Private Integration Token in HighLevel under Settings → Private Integrations, select the scopes you want the AI to use, and paste that token into the connect form along with your Location ID (sub-account). There is no client secret and no redirect URL to register anywhere.
It is the id of the sub-account you want the AI working in, and every call the connector makes is pinned to it. The AI never has to pass the location id or the API version — the connector fills both in on each request, so a model can't wander into the wrong sub-account by guessing an id. Working in a second sub-account means a second connection carrying that sub-account's id.
There are two levers. Scopes are chosen inside HighLevel when you create the Private Integration Token, so the token itself only reaches the areas you ticked — and that choice is made in HighLevel, not in PopMCP. On the PopMCP side you can set the connection to read-only, or keep full access with approval required for writes, which is worth doing given 312 of the 557 operations write.
65 of the 557 operations load by default so the client isn't swamped by a 41-module API; the rest stay searchable and your agent can pull one in when it needs it. Flip the full-catalog toggle if you want everything loaded up front. The heaviest modules are Ad manager (94 operations), Invoices (42), Calendars (41) and Social media posting (37).
Yes. ghl_search_conversation finds threads matching your filters, ghl_get_conversation and ghl_get_messages pull the detail, and ghl_send_a_new_message posts a reply; ghl_create_conversation opens a new thread. Sending is a write, so with approval required for writes it waits for your sign-off before anything leaves the account. The Conversation started trigger can wake an agent when a new thread opens on any channel.
The whole loop: ghl_list_invoices and ghl_get_invoice to read, ghl_create_invoice to raise one, ghl_send_invoice to send it, ghl_record_invoice to log a manual payment, and ghl_void_invoice to void one. Invoices is the second-largest module at 42 operations, with Payments adding another 23. Triggers for Invoice created, Payment received and Subscription started let an agent react to billing activity instead of polling for it.
No. PopMCP hosts it and gives you a Streamable HTTP MCP URL. There is nothing to deploy, no callback URL to register, and no infrastructure to keep running or patch.
Any client that supports a remote Streamable HTTP MCP server — Claude Desktop, Claude Web, ChatGPT custom connectors, Codex and the Codex CLI, OpenCode and Z.ai's ZCode, as well as editors such as Cursor, Windsurf and Zed. Your client signs in to PopMCP with OAuth; the provider credential never leaves the server.
Loading 557 tool definitions into every conversation burns context before the work starts. PopMCP loads a curated 65-tool set covering the everyday workflows and keeps the rest searchable, so your AI pulls a specialist tool only when a task needs it. You can switch a connection to the full catalog at any time.
A tool is something your AI calls — there are 557 here. A trigger is something PopMCP watches for you: 18 GoHighLevel events that can start work on the PopMCP side. Triggers never enter your AI client's context, and none of them ask you to paste a callback URL into GoHighLevel.
Launch a hosted MCP endpoint for GoHighLevel, keep tool access under control, and start testing real workflow prompts right away.