Funding-Machine-ghl-mcp-fundingmachine

Server Details

Automate GoHighLevel across CRM, messaging, calendars, marketing, e-commerce, and billing. Manage…

Status: Healthy
Last Tested: 2026-01-30 14:30
Transport: Streamable HTTP
URL

Available Tools

364 tools

add_contact_followersTry in Inspector

Add followers to a contact

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID
`followers`	Yes	Array of user IDs to add as followers

add_contact_tagsTry in Inspector

Add tags to a contact

ParametersJSON Schema

Name	Required	Description	Default
`tags`	Yes	Tags to add
`contactId`	Yes	Contact ID

add_contact_to_campaignTry in Inspector

Add contact to a marketing campaign

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID
`campaignId`	Yes	Campaign ID

add_contact_to_workflowTry in Inspector

Add contact to a workflow

ParametersJSON Schema

Name	Required	Description
`contactId`	Yes	Contact ID
`workflowId`	Yes	Workflow ID
`eventStartTime`	No	Event start time (ISO format)

add_inbound_messageTry in Inspector

Manually add an inbound message to a conversation

ParametersJSON Schema

Name	Required	Description
`call`	No	Call details for call-type messages
`date`	No	Date of the message (ISO format)
`html`	No	HTML content for email messages
`type`	Yes	Type of inbound message to add
`altId`	No	External provider message ID
`emailCc`	No	CC email addresses
`emailTo`	No	To email address
`message`	No	Message content (for text-based messages)
`subject`	No	Subject line for email messages
`emailBcc`	No	BCC email addresses
`emailFrom`	No	From email address
`attachments`	No	Array of attachment URLs
`conversationId`	Yes	The conversation to add the message to
`emailMessageId`	No	Email message ID for threading
`conversationProviderId`	Yes	Conversation provider ID for the message

add_opportunity_followersTry in Inspector

Add followers to an opportunity for notifications and tracking

ParametersJSON Schema

Name	Required	Description	Default
`followers`	Yes	Array of user IDs to add as followers
`opportunityId`	Yes	The unique ID of the opportunity

add_outbound_callTry in Inspector

Manually add an outbound call record to a conversation

ParametersJSON Schema

Name	Required	Description
`to`	Yes	Called phone number
`date`	No	Date of the call (ISO format)
`from`	Yes	Caller phone number
`altId`	No	External provider call ID
`status`	Yes	Call completion status
`attachments`	No	Array of attachment URLs
`conversationId`	Yes	The conversation to add the call to
`conversationProviderId`	Yes	Conversation provider ID for the call

attach_action_to_agentTry in Inspector

Creates and attaches 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, or collecting information. NOTE: Only name, type, and details are accepted - enabled, description, and order are NOT valid for this endpoint.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the action (e.g., "Book Appointment", "Trigger a Workflow")
`type`	Yes	Type of action to perform
`agentId`	Yes	Unique identifier of the AI agent
`details`	Yes	Action-specific configuration object. Required fields depend on action type: FOR appointmentBooking: REQUIRED: - calendarId (string): Calendar ID for booking OPTIONAL: - onlySendLink (boolean): If true, only sends booking link without booking - triggerWorkflow (boolean): Whether to trigger workflow after booking - sleepAfterBooking (boolean): Whether to sleep agent after booking - transferBot (boolean): Whether to transfer to another agent - rescheduleEnabled (boolean): Allow rescheduling - cancelEnabled (boolean): Allow cancellation CONDITIONAL: - workflowIds (string[]): Required when triggerWorkflow is true - sleepTimeUnit ('days'\|'hours'\|'minutes') and sleepTime (number): Required when sleepAfterBooking is true - transferAgent (string): Required when transferBot is true NOTE: When onlySendLink is true, triggerWorkflow, sleepAfterBooking, transferBot, rescheduleEnabled, and cancelEnabled must be false FOR triggerWorkflow: REQUIRED: - workflowIds (string[]): Array of workflow IDs - triggerCondition (string): Condition to trigger OPTIONAL: - triggerMessage (string): Message to send when triggering FOR updateContactField: REQUIRED: - contactFieldId (string): Field ID to update - description (string): Field description OPTIONAL: - contactUpdateExamples (string[]): Example values (not required for standard fields, Monetary, or Date custom fields) FOR stopBot: REQUIRED: - stopBotDetectionType ('Goodbye' \| 'Custom'): Detection type - stopBotTriggerCondition (string): Trigger condition - reactivateEnabled (boolean): Can reactivate - enabled (boolean): Is enabled - stopBotExamples (string[]): At least 2 example phrases - finalMessage (string): Final message when stopping OPTIONAL: - tags (string[]): Tags to apply when stopping CONDITIONAL: - sleepTimeUnit ('days'\|'hours'\|'minutes') and sleepTime (number): Required when reactivateEnabled is true FOR humanHandOver: REQUIRED: - enabled (boolean): Is enabled - triggerCondition (string): Trigger condition - reactivateEnabled (boolean): Can reactivate - finalMessage (string): Final message - handoverType ('contactRequest' \| 'lackOfInformation' \| 'failedResolvedIssue' \| 'custom') OPTIONAL: - assignToUserId (string): User ID to assign conversation to - skipAssignToUser (boolean): Skip assigning to specific user - createTask (boolean): Create task when handing over - tags (string[]): Tags to apply during handover CONDITIONAL: - examples (string[]): Required when handoverType is 'custom' or 'contactRequest' - sleepTimeUnit ('days'\|'hours'\|'minutes') and sleepTime (number): Required when reactivateEnabled is true FOR advancedFollowup: REQUIRED: - enabled (boolean): Is enabled - scenarioId ('contactStoppedReplying' \| 'contactIsBusy' \| 'contactRequested'): Scenario trigger - followupSequence (array): Array of followup steps FOLLOWUP SEQUENCE ITEM REQUIRED: - id (number 1-5): Step identifier (must be integer, not string) - followupTimeUnit ('days' \| 'hours' \| 'minutes'): Time unit for delay - followupTime (number): Duration value (minutes: 1-60, hours: 1-24, days: 1-180) FOLLOWUP SEQUENCE ITEM OPTIONAL: - aiEnabledMessage (boolean, default true): Use AI to generate message - triggerWorkflow (boolean, default false): Trigger a workflow - customMessage (string): Custom message (required when aiEnabledMessage is false) - workflowId (string): Workflow ID (required when triggerWorkflow is true) - contactRequested (boolean): Whether contact was requested OPTIONAL followupSettings: - dynamicChannelSwitching (boolean, required if settings included): Enable channel switching - followUpHours (boolean): Respect working hours - workingHours (array): Working hour definitions - timezoneToUse ('contact' \| 'business'): Timezone source FOR transferBot: REQUIRED: - transferBotType ('Default' \| 'Custom'): Transfer type - transferToBot (string): Agent ID to transfer to - enabled (boolean): Is enabled CONDITIONAL (required when transferBotType is 'Custom'): - transferBotTriggerCondition (string): Condition that triggers transfer - transferBotExamples (string[]): At least 2 example phrases

autopayment_invoice_scheduleTry in Inspector

Configure autopayment for an invoice schedule

ParametersJSON Schema

Name	Required	Description
`altId`	No	Location ID
`enabled`	Yes	Enable or disable autopayment
`scheduleId`	Yes	Schedule ID
`paymentMethodId`	No	Payment method ID

bulk_delete_social_postsTry in Inspector

Delete multiple social media posts at once (max 50)

ParametersJSON Schema

Name	Required	Description	Default
`postIds`	Yes	Array of post IDs to delete

bulk_update_contact_businessTry in Inspector

Bulk update business association for multiple contacts

ParametersJSON Schema

Name	Required	Description	Default
`businessId`	No	Business ID (null to remove from business)
`contactIds`	Yes	Array of contact IDs

bulk_update_contact_tagsTry in Inspector

Bulk add or remove tags from multiple contacts

ParametersJSON Schema

Name	Required	Description
`tags`	Yes	Tags to add or remove
`operation`	Yes	Operation to perform
`contactIds`	Yes	Array of contact IDs
`removeAllTags`	No	Remove all existing tags before adding new ones

cancel_invoice_scheduleTry in Inspector

Cancel an invoice schedule

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID (optional, defaults to configured location)
`scheduleId`	Yes	Schedule ID

cancel_scheduled_emailTry in Inspector

Cancel a scheduled email before it is sent

ParametersJSON Schema

Name	Required	Description	Default
`emailMessageId`	Yes	The unique ID of the scheduled email to cancel

cancel_scheduled_messageTry in Inspector

Cancel a scheduled message before it is sent

ParametersJSON Schema

Name	Required	Description	Default
`messageId`	Yes	The unique ID of the scheduled message to cancel

check_url_slugTry in Inspector

Check if a URL slug is available for use. Use this before creating or updating blog posts to ensure unique URLs.

ParametersJSON Schema

Name	Required	Description	Default
`postId`	No	Optional post ID when updating an existing post (to exclude itself from the check)
`urlSlug`	Yes	URL slug to check for availability

create_appointmentTry in Inspector

Create a new appointment/booking in GoHighLevel

ParametersJSON Schema

Name	Required	Description	Default
`title`	No	Title/subject of the appointment
`address`	No	Meeting location or address
`endTime`	No	End time in ISO format (optional, will be calculated from slot duration if not provided)
`toNotify`	No	Send notifications for this appointment
`contactId`	Yes	The contact ID for whom to book the appointment
`startTime`	Yes	Start time in ISO format (e.g., "2024-01-15T10:00:00-05:00")
`calendarId`	Yes	The calendar ID to book the appointment in
`assignedUserId`	No	User ID to assign this appointment to
`ignoreDateRange`	No	Ignore minimum scheduling notice and date range restrictions
`appointmentStatus`	No	Initial status of the appointment	confirmed
`meetingLocationType`	No	Type of meeting location	custom

create_appointment_noteTry in Inspector

Create a note for an appointment

ParametersJSON Schema

Name	Required	Description
`body`	Yes	Note content
`userId`	No	User ID creating the note
`appointmentId`	Yes	Appointment ID

create_block_slotTry in Inspector

Create a blocked time slot to prevent bookings during specific times

ParametersJSON Schema

Name	Required	Description
`title`	No	Title/reason for the block (e.g., "Lunch Break", "Meeting")
`endTime`	Yes	End time of the block in ISO format (e.g., "2024-01-15T12:00:00-05:00")
`startTime`	Yes	Start time of the block in ISO format (e.g., "2024-01-15T10:00:00-05:00")
`calendarId`	No	Specific calendar to block (optional, blocks all if not specified)
`assignedUserId`	No	User ID to apply the block for

create_blog_postTry in Inspector

Create a new blog post in GoHighLevel. Requires blog ID, author ID, and category IDs which can be obtained from other blog tools.

ParametersJSON Schema

Name	Required	Description	Default
`tags`	No	Optional array of tags for the blog post
`title`	Yes	Blog post title
`author`	Yes	Author ID (use get_blog_authors to find available authors)
`blogId`	Yes	Blog site ID (use get_blog_sites to find available blogs)
`status`	No	Publication status of the blog post	DRAFT
`content`	Yes	Full HTML content of the blog post
`urlSlug`	Yes	URL slug for the blog post (use check_url_slug to verify availability)
`imageUrl`	Yes	URL of the featured image for the blog post
`categories`	Yes	Array of category IDs (use get_blog_categories to find available categories)
`description`	Yes	Short description/excerpt of the blog post
`publishedAt`	No	Optional ISO timestamp for publication date (defaults to now for PUBLISHED status)
`imageAltText`	Yes	Alt text for the featured image (for SEO and accessibility)
`canonicalLink`	No	Optional canonical URL for SEO

create_businessTry in Inspector

Create a new business

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Business name
`email`	No	Business email
`phone`	No	Business phone number
`address`	No	Business address
`website`	No	Business website
`locationId`	No	Location ID (optional)

create_calendarTry in Inspector

Create a new calendar in GoHighLevel

ParametersJSON Schema

Name	Required	Description	Default
`name`	Yes	Name of the calendar
`slug`	No	URL slug for the calendar
`groupId`	No	Calendar group ID to organize the calendar
`isActive`	No	Make calendar active immediately (default: true)
`openHours`	No	Weekly availability configuration for the calendar
`autoConfirm`	No	Automatically confirm appointments (default: true)
`description`	No	Description of the calendar
`teamMembers`	No	Team members assigned to the calendar
`calendarType`	Yes	Type of calendar to create	event
`slotDuration`	No	Duration of appointment slots in minutes (default: 30)
`availabilities`	No	Availability rules for the calendar (e.g., specific dates or recurring patterns)
`allowReschedule`	No	Allow clients to reschedule appointments (default: true)
`slotDurationUnit`	No	Unit for slot duration	mins
`allowCancellation`	No	Allow clients to cancel appointments (default: true)
`locationConfigurations`	No	Location-specific configurations for the calendar

create_calendar_groupTry in Inspector

Create a new calendar group

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Group name
`slug`	Yes	URL slug for the group
`isActive`	No	Whether group is active
`description`	Yes	Group description

create_calendar_notificationsTry in Inspector

Create calendar notifications

ParametersJSON Schema

Name	Required	Description	Default
`calendarId`	Yes	Calendar ID
`notifications`	Yes	Array of notification configurations

create_calendar_resource_equipmentTry in Inspector

Create a calendar equipment resource

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Equipment name
`capacity`	Yes	Capacity per unit
`quantity`	Yes	Total quantity available
`calendarIds`	Yes	Associated calendar IDs
`description`	Yes	Equipment description
`outOfService`	Yes	Number currently out of service

create_calendar_resource_roomTry in Inspector

Create a calendar room resource

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Room name
`capacity`	Yes	Room capacity
`quantity`	Yes	Total quantity available
`calendarIds`	Yes	Associated calendar IDs
`description`	Yes	Room description
`outOfService`	Yes	Number currently out of service

create_category_queueTry in Inspector

Create a new category queue for automated social media posting

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Queue name
`accountIds`	Yes	Array of social media account IDs to post to
`categoryId`	Yes	Category ID to associate with queue
`locationId`	Yes	Location ID
`scheduleDays`	No	Days of week for weekly schedule (0-6, where 0 is Sunday)
`scheduleTime`	No	Time to schedule posts (HH:mm format)
`scheduleType`	Yes	Schedule type for queue

create_category_queue_itemTry in Inspector

Add a new item to a category queue

ParametersJSON Schema

Name	Required	Description
`order`	No	Order position in queue
`postId`	Yes	Post ID to add to queue
`queueId`	Yes	Category queue ID
`locationId`	Yes	Location ID
`scheduledDate`	No	Scheduled date for item (ISO format)

create_contactTry in Inspector

Create a new contact in GoHighLevel

ParametersJSON Schema

Name	Required	Description
`tags`	No	Tags to assign to contact
`email`	Yes	Contact email address
`phone`	No	Contact phone number
`source`	No	Source of the contact
`lastName`	No	Contact last name
`firstName`	No	Contact first name

create_contact_noteTry in Inspector

Create a new note for a contact

ParametersJSON Schema

Name	Required	Description
`body`	Yes	Note content
`userId`	No	User ID creating the note
`contactId`	Yes	Contact ID

create_contact_taskTry in Inspector

Create a new task for a contact

ParametersJSON Schema

Name	Required	Description
`body`	No	Task description
`title`	Yes	Task title
`dueDate`	Yes	Due date (ISO format)
`completed`	No	Task completion status
`contactId`	Yes	Contact ID
`assignedTo`	No	User ID to assign task to

create_conversationTry in Inspector

Create a new conversation with a contact

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	The unique ID of the contact to create conversation with

create_conversation_ai_agentTry in Inspector

Create a new AI agent for automated conversations

ParametersJSON Schema

Name	Required	Description	Default
`goal`	Yes	The goal of the agent (e.g., "Assist customers with inquiries")
`mode`	No	Mode of operation - OFF, SUGGESTIVE, or AUTO_PILOT	off
`name`	Yes	Name of the AI agent
`channels`	No	Communication channels the agent can operate on
`waitTime`	No	Wait time before agent responds (max 5 for minutes, 300 for seconds)
`isPrimary`	No	Indicates if this agent is a primary agent
`sleepTime`	No	Duration of sleep period (required if sleepEnabled is true)
`personality`	Yes	Personality traits of the agent (e.g., "Friendly and helpful")
`businessName`	No	Name of the business the agent represents
`instructions`	Yes	Instructions for the agent (e.g., "Provide customer service")
`sleepEnabled`	No	Indicates if sleep functionality is enabled
`waitTimeUnit`	No	Unit for wait time - SECONDS or MINUTES	seconds
`sleepTimeUnit`	No	Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true)
`respondToAudio`	No	Allow agent to respond to audio
`respondToImages`	No	Allow agent to respond to images
`knowledgeBaseIds`	No	Array of knowledge base IDs associated with this agent
`autoPilotMaxMessages`	No	Maximum number of messages in auto-pilot mode before requiring human intervention (max: 25, min: 1)

create_couponTry in Inspector

Create a new promotional coupon

ParametersJSON Schema

Name	Required	Description
`code`	Yes	Coupon code
`name`	Yes	Coupon name
`altId`	Yes	Location ID
`altType`	Yes	Alt Type
`endDate`	No	End date in YYYY-MM-DDTHH:mm:ssZ format
`startDate`	Yes	Start date in YYYY-MM-DDTHH:mm:ssZ format
`productIds`	No	Product IDs that the coupon applies to
`usageLimit`	No	Maximum number of times coupon can be used
`discountType`	Yes	Type of discount
`discountValue`	Yes	Discount value
`limitPerCustomer`	No	Whether to limit coupon to once per customer
`applyToFuturePayments`	No	Whether coupon applies to future subscription payments
`applyToFuturePaymentsConfig`	No	Configuration for future payments application

create_custom_menuTry in Inspector

Create a new custom menu

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Menu name
`items`	Yes	Menu items
`locationId`	No	Location ID (optional)

create_custom_provider_configTry in Inspector

Create new payment config for a location

ParametersJSON Schema

Name	Required	Description
`live`	Yes	Live payment configuration
`test`	Yes	Test payment configuration
`locationId`	Yes	Location ID

create_custom_provider_integrationTry in Inspector

Create a new custom payment provider integration

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the custom provider
`imageUrl`	Yes	Public image URL for the payment gateway logo
`queryUrl`	Yes	URL for querying payment events
`locationId`	Yes	Location ID
`description`	Yes	Description of the payment gateway
`paymentsUrl`	Yes	URL to load in iframe for payment session

create_email_templateTry in Inspector

Create a new email template in GoHighLevel.

ParametersJSON Schema

Name	Required	Description
`html`	Yes	HTML content of the template.
`title`	Yes	Title of the new template.
`isPlainText`	No	Whether the template is plain text.

create_estimateTry in Inspector

Create a new estimate

ParametersJSON Schema

Name	Required	Description
`altId`	No	Location ID
`title`	Yes	Estimate title
`currency`	No	Currency code
`contactId`	Yes	Contact ID
`issueDate`	No	Issue date
`validUntil`	No	Valid until date

create_faqTry in Inspector

Create a new FAQ in a knowledge base

ParametersJSON Schema

Name	Required	Description
`answer`	Yes	The FAQ answer
`question`	Yes	The FAQ question
`locationId`	Yes	The location ID
`knowledgeBaseId`	Yes	The knowledge base ID

create_invoiceTry in Inspector

Create a new invoice

ParametersJSON Schema

Name	Required	Description
`altId`	No	Location ID
`items`	No	Invoice items
`title`	Yes	Invoice title
`dueDate`	No	Due date
`currency`	No	Currency code
`contactId`	Yes	Contact ID
`issueDate`	No	Issue date

create_invoice_from_estimateTry in Inspector

Create an invoice from an estimate

ParametersJSON Schema

Name	Required	Description
`altId`	No	Location ID
`dueDate`	No	Invoice due date
`issueDate`	No	Invoice issue date
`estimateId`	Yes	Estimate ID

create_invoice_scheduleTry in Inspector

Create a new invoice schedule

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Schedule name
`altId`	No	Location ID
`contactId`	Yes	Contact ID
`frequency`	No	Schedule frequency
`templateId`	Yes	Template ID

create_invoice_templateTry in Inspector

Create a new invoice template

ParametersJSON Schema

Name	Required	Description	Default
`name`	Yes	Template name
`altId`	No	Location ID
`title`	No	Invoice title
`altType`	No		location
`dueDate`	No	Due date
`currency`	No	Currency code
`issueDate`	No	Issue date

create_knowledge_baseTry in Inspector

Create a new knowledge base (max 15 per location)

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the knowledge base
`locationId`	No	The location ID (optional, uses default if not provided)
`description`	No	Description of the knowledge base

create_linkTry in Inspector

Create a new trigger link

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Link name
`tags`	No	Tags to add to contact when link is clicked
`locationId`	No	Location ID (optional)
`workflowId`	No	Workflow to trigger when link is clicked
`redirectUrl`	Yes	URL to redirect to when link is clicked

create_locationTry in Inspector

Create a new sub-account/location in GoHighLevel (Agency Pro plan required)

ParametersJSON Schema

Name	Required	Description
`city`	No	City where business is located
`name`	Yes	Name of the sub-account/location
`phone`	No	Phone number with country code (e.g., +1410039940)
`state`	No	State where business operates
`address`	No	Business address
`country`	No	2-letter country code (e.g., US, CA, GB)
`website`	No	Business website URL
`timezone`	No	Business timezone (e.g., US/Central)
`companyId`	Yes	Company/Agency ID
`postalCode`	No	Postal/ZIP code
`snapshotId`	No	Snapshot ID to load into the location
`prospectInfo`	No	Prospect information for the location

create_location_custom_fieldTry in Inspector

Create a new custom field for a location

ParametersJSON Schema

Name	Required	Description	Default
`name`	Yes	Name of the custom field
`model`	No	Model to create the field for	contact
`dataType`	Yes	Data type of the field (TEXT, NUMBER, DATE, etc.)
`position`	No	Position/order of the field (default: 0)
`locationId`	Yes	The location ID
`placeholder`	No	Placeholder text for the field

create_location_custom_valueTry in Inspector

Create a new custom value for a location

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the custom value field
`value`	Yes	Value to assign
`locationId`	Yes	The location ID

create_location_tagTry in Inspector

Create a new tag for a location

ParametersJSON Schema

Name	Required	Description	Default
`name`	Yes	Name of the tag to create
`locationId`	Yes	The location ID to create tag in

create_object_recordTry in Inspector

Create a new record in a custom or standard object with properties, owner, and followers

ParametersJSON Schema

Name	Required	Description
`owner`	No	Array of user IDs who own this record (limited to 1, only for custom objects)
`followers`	No	Array of user IDs who follow this record (limited to 10)
`schemaKey`	Yes	Schema key of the object (e.g., "custom_objects.pet", "business")
`locationId`	No	Location ID (uses default if not provided)
`properties`	Yes	Record properties as key-value pairs (e.g., {"name": "Buddy", "breed": "Golden Retriever"})

create_object_schemaTry in Inspector

Create a new custom object schema with labels, key, and primary display property

ParametersJSON Schema

Name	Required	Description
`key`	Yes	Unique key for the object (e.g., "custom_objects.pet"). The "custom_objects." prefix is added automatically if not included
`labels`	Yes	Singular and plural names for the custom object
`locationId`	No	Location ID (uses default if not provided)
`description`	No	Description of the custom object
`primaryDisplayPropertyDetails`	Yes	Primary property configuration for display

create_opportunityTry in Inspector

Create a new opportunity in GoHighLevel CRM

ParametersJSON Schema

Name	Required	Description	Default
`name`	Yes	Name/title of the opportunity
`status`	No	Initial status of the opportunity (default: open)	open
`contactId`	Yes	ID of the contact associated with this opportunity
`assignedTo`	No	User ID to assign this opportunity to
`pipelineId`	Yes	ID of the pipeline this opportunity belongs to
`monetaryValue`	No	Monetary value of the opportunity in dollars

create_order_fulfillmentTry in Inspector

Create a fulfillment for an order

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Location ID or Agency ID
`items`	Yes	Items being fulfilled
`altType`	Yes	Alt Type
`orderId`	Yes	ID of the order to fulfill
`trackings`	Yes	Fulfillment tracking information
`notifyCustomer`	Yes	Whether to notify the customer

create_social_postTry in Inspector

Create a new social media post for multiple platforms

ParametersJSON Schema

Name	Required	Description	Default
`tags`	No	Tag IDs to associate with post
`type`	Yes	Type of post
`media`	No	Media attachments
`status`	No	Post status	draft
`userId`	No	User ID creating the post
`summary`	Yes	Post content/text
`accountIds`	Yes	Array of social media account IDs to post to
`categoryId`	No	Category ID
`scheduleDate`	No	Schedule date for post (ISO format)
`followUpComment`	No	Follow-up comment

create_userTry in Inspector

Create a new user in the system. User will be assigned to specified locations with the given permissions and scopes.

ParametersJSON Schema

Name	Required	Description
`role`	Yes	User role (required). Example: "admin"
`type`	Yes	User type (required)
`email`	Yes	User email address (required). Example: "john@deo.com"
`phone`	No	Phone number. Example: "+18832327657"
`scopes`	No	Array of scopes to enable. Example: ["contacts.write", "campaigns.readonly"]
`lastName`	Yes	User last name (required). Example: "Deo"
`password`	Yes	User password (required)
`companyId`	Yes	Company/Agency ID (required). Example: "ve9EPM428h8vShlRW1KT"
`firstName`	Yes	User first name (required). Example: "John"
`locationIds`	Yes	Array of location IDs to assign user to (required). Example: ["C2QujeCh8ZnC7al2InWR"]
`permissions`	No	User permissions object with boolean flags for various features (campaignsEnabled, contactsEnabled, etc.)
`profilePhoto`	No	URL to profile photo. Example: "https://img.png"
`scopesAssignedToOnly`	No	Array of assigned-only scopes. Example: ["contacts.write"]

create_voice_ai_agentTry in Inspector

Create a new Voice AI agent configuration for handling phone calls with AI

ParametersJSON Schema

Name	Required	Description	Default
`name`	Yes	Name of the Voice AI agent
`model`	No	AI model to use (e.g., "gpt-4", "gpt-3.5-turbo")	gpt-4
`prompt`	Yes	System prompt/instructions for the Voice AI agent
`voiceId`	Yes	ID of the voice to use for the agent
`language`	No	Language code for the agent (e.g., "en-US", "es-ES")	en-US
`maxDuration`	No	Maximum call duration in seconds
`temperature`	No	Temperature setting for AI responses (0-2)
`firstMessage`	Yes	First message the agent says when answering a call
`recordingEnabled`	No	Whether to enable call recording
`voicemailEnabled`	No	Whether to enable voicemail detection

create_whitelabel_integration_providerTry in Inspector

Create a white-label integration provider for payments

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Location ID or company ID based on altType
`title`	Yes	The title or name of the integration provider
`altType`	Yes	Alt Type
`imageUrl`	Yes	The URL to an image representing the integration provider
`provider`	Yes	The type of payment provider
`uniqueName`	Yes	A unique name for the integration provider (lowercase, hyphens only)
`description`	Yes	A brief description of the integration provider

delete_actionTry in Inspector

Remove an action from an AI agent

ParametersJSON Schema

Name	Required	Description	Default
`agentId`	Yes	Unique identifier of the AI agent
`actionId`	Yes	Unique identifier of the action to remove

delete_appointmentTry in Inspector

Cancel/delete an appointment from GoHighLevel

ParametersJSON Schema

Name	Required	Description	Default
`appointmentId`	Yes	The unique ID of the appointment to delete

delete_appointment_noteTry in Inspector

Delete an appointment note

ParametersJSON Schema

Name	Required	Description	Default
`noteId`	Yes	Note ID
`appointmentId`	Yes	Appointment ID

delete_businessTry in Inspector

Delete a business

ParametersJSON Schema

Name	Required	Description	Default
`businessId`	Yes	Business ID to delete

delete_calendarTry in Inspector

Delete a calendar from GoHighLevel

ParametersJSON Schema

Name	Required	Description	Default
`calendarId`	Yes	The unique ID of the calendar to delete

delete_calendar_groupTry in Inspector

Delete a calendar group

ParametersJSON Schema

Name	Required	Description	Default
`groupId`	Yes	Calendar group ID

delete_calendar_notificationTry in Inspector

Delete calendar notification

ParametersJSON Schema

Name	Required	Description	Default
`calendarId`	Yes	Calendar ID
`notificationId`	Yes	Notification ID

delete_calendar_resource_equipmentTry in Inspector

Delete an equipment resource

ParametersJSON Schema

Name	Required	Description	Default
`resourceId`	Yes	Equipment resource ID

delete_calendar_resource_roomTry in Inspector

Delete a room resource

ParametersJSON Schema

Name	Required	Description	Default
`resourceId`	Yes	Room resource ID

delete_category_queue_itemTry in Inspector

Delete an item from a category queue

ParametersJSON Schema

Name	Required	Description
`itemId`	Yes	Queue item ID to delete
`queueId`	Yes	Category queue ID
`locationId`	Yes	Location ID

delete_contactTry in Inspector

Delete a contact from GoHighLevel

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID

delete_contact_noteTry in Inspector

Delete a note for a contact

ParametersJSON Schema

Name	Required	Description	Default
`noteId`	Yes	Note ID
`contactId`	Yes	Contact ID

delete_contact_taskTry in Inspector

Delete a task for a contact

ParametersJSON Schema

Name	Required	Description	Default
`taskId`	Yes	Task ID
`contactId`	Yes	Contact ID

delete_conversationTry in Inspector

Delete a conversation permanently

ParametersJSON Schema

Name	Required	Description	Default
`conversationId`	Yes	The unique ID of the conversation to delete

delete_conversation_ai_agentTry in Inspector

Permanently delete an AI agent and all its configurations

ParametersJSON Schema

Name	Required	Description	Default
`agentId`	Yes	Unique identifier of the AI agent to delete

delete_couponTry in Inspector

Delete a coupon permanently

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Coupon ID
`altId`	Yes	Location ID
`altType`	Yes	Alt Type

delete_csvTry in Inspector

Delete a CSV import

ParametersJSON Schema

Name	Required	Description	Default
`csvId`	Yes	CSV import ID to delete

delete_csv_postTry in Inspector

Delete a specific post from a CSV import

ParametersJSON Schema

Name	Required	Description	Default
`csvId`	Yes	CSV import ID
`postId`	Yes	Post ID to delete from CSV import

delete_current_active_post_and_schedule_nextTry in Inspector

Delete the currently active post and schedule the next item in queue

ParametersJSON Schema

Name	Required	Description	Default
`queueId`	Yes	Category queue ID
`locationId`	Yes	Location ID

delete_custom_menuTry in Inspector

Delete a custom menu

ParametersJSON Schema

Name	Required	Description	Default
`menuId`	Yes	Menu ID to delete
`locationId`	No	Location ID (optional)

delete_custom_provider_integrationTry in Inspector

Delete an existing custom payment provider integration

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	Location ID

delete_email_templateTry in Inspector

Delete an email template from GoHighLevel.

ParametersJSON Schema

Name	Required	Description	Default
`templateId`	Yes	The ID of the template to delete.

delete_estimateTry in Inspector

Delete an estimate

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`estimateId`	Yes	Estimate ID

delete_faqTry in Inspector

Delete an FAQ from a knowledge base

ParametersJSON Schema

Name	Required	Description	Default
`faqId`	Yes	The FAQ ID
`knowledgeBaseId`	Yes	The knowledge base ID

delete_invoiceTry in Inspector

Delete an invoice

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`invoiceId`	Yes	Invoice ID

delete_invoice_scheduleTry in Inspector

Delete an invoice schedule

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`scheduleId`	Yes	Schedule ID

delete_invoice_templateTry in Inspector

Delete an invoice template

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`templateId`	Yes	Template ID

delete_knowledge_baseTry in Inspector

Delete a knowledge base

ParametersJSON Schema

Name	Required	Description	Default
`knowledgeBaseId`	Yes	The knowledge base ID

delete_linkTry in Inspector

Delete a trigger link

ParametersJSON Schema

Name	Required	Description	Default
`linkId`	Yes	Link ID to delete
`locationId`	No	Location ID (optional)

delete_locationTry in Inspector

Delete a sub-account/location from GoHighLevel

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The unique ID of the location to delete
`deleteTwilioAccount`	Yes	Whether to delete associated Twilio account

delete_location_custom_fieldTry in Inspector

Delete a custom field from a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The location ID
`customFieldId`	Yes	The custom field ID to delete

delete_location_custom_valueTry in Inspector

Delete a custom value from a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The location ID
`customValueId`	Yes	The custom value ID to delete

delete_location_tagTry in Inspector

Delete a location tag

ParametersJSON Schema

Name	Required	Description	Default
`tagId`	Yes	The tag ID to delete
`locationId`	Yes	The location ID

delete_location_templateTry in Inspector

Delete a template from a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The location ID
`templateId`	Yes	The template ID to delete

delete_media_fileTry in Inspector

Delete a specific file or folder from the media library

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	ID of the file or folder to delete
`altId`	No	Location or Agency ID (uses default location if not provided)
`altType`	No	Context type (location or agency)	location

delete_object_recordTry in Inspector

Delete a record from a custom or standard object

ParametersJSON Schema

Name	Required	Description	Default
`recordId`	Yes	ID of the record to delete
`schemaKey`	Yes	Schema key of the object

delete_opportunityTry in Inspector

Delete an opportunity from GoHighLevel CRM

ParametersJSON Schema

Name	Required	Description	Default
`opportunityId`	Yes	The unique ID of the opportunity to delete

delete_social_accountTry in Inspector

Delete a social media account connection

ParametersJSON Schema

Name	Required	Description
`userId`	No	User ID
`accountId`	Yes	Account ID to delete
`companyId`	No	Company ID

delete_social_postTry in Inspector

Delete a social media post

ParametersJSON Schema

Name	Required	Description	Default
`postId`	Yes	Social media post ID to delete

delete_trained_pagesTry in Inspector

Delete trained pages from a knowledge base

ParametersJSON Schema

Name	Required	Description	Default
`urls`	Yes	Array of URLs to delete
`knowledgeBaseId`	Yes	The knowledge base ID

delete_userTry in Inspector

Delete a user. The deletion is queued and will take effect in a few minutes.

ParametersJSON Schema

Name	Required	Description	Default
`userId`	Yes	User ID to delete (required)

delete_voice_ai_agentTry in Inspector

Delete a Voice AI agent and all its configurations

ParametersJSON Schema

Name	Required	Description	Default
`agentId`	Yes	Unique identifier of the Voice AI agent to delete

disable_calendar_groupTry in Inspector

Enable or disable a calendar group

ParametersJSON Schema

Name	Required	Description	Default
`groupId`	Yes	Calendar group ID
`isActive`	Yes	Whether to enable (true) or disable (false) the group

disable_saas_modeTry in Inspector

Disable SaaS mode for a location

ParametersJSON Schema

Name	Required	Description	Default
`companyId`	Yes	Company ID

disconnect_custom_provider_configTry in Inspector

Disconnect existing payment config for a location

ParametersJSON Schema

Name	Required	Description	Default
`liveMode`	Yes	Whether to disconnect live or test mode config
`locationId`	Yes	Location ID

discover_websiteTry in Inspector

Start crawling and discover pages for training

ParametersJSON Schema

Name	Required	Description
`url`	Yes	The website URL to crawl
`maxPages`	No	Maximum number of pages to discover
`knowledgeBaseId`	Yes	The knowledge base ID

download_transcriptionTry in Inspector

Download call transcription as a text file

ParametersJSON Schema

Name	Required	Description	Default
`messageId`	Yes	The unique ID of the call message to download transcription for

enable_saas_modeTry in Inspector

Enable SaaS mode for a location

ParametersJSON Schema

Name	Required	Description	Default
`paused`	No	Whether to pause the SaaS subscription
`companyId`	Yes	Company ID

execute_agent_studio_agentTry in Inspector

Execute an Agent Studio agent and get non-streaming JSON response

ParametersJSON Schema

Name	Required	Description
`input`	No	Input data for the agent execution
`agentId`	Yes	The agent ID
`locationId`	Yes	The location ID (required for execution)

fetch_available_categories_for_queueTry in Inspector

Get available categories that can be used for creating category queues

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	Location ID

fetch_category_queue_by_idTry in Inspector

Get specific category queue details by ID

ParametersJSON Schema

Name	Required	Description	Default
`queueId`	Yes	Category queue ID
`locationId`	Yes	Location ID

fetch_category_queue_calendarTry in Inspector

Get calendar view of scheduled posts for a category queue

ParametersJSON Schema

Name	Required	Description
`endDate`	No	End date for calendar view (ISO format)
`queueId`	Yes	Category queue ID
`startDate`	No	Start date for calendar view (ISO format)
`locationId`	Yes	Location ID

fetch_category_queue_itemsTry in Inspector

Get items in a category queue

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of items to skip
`limit`	No	Number of items to return
`status`	No	Filter items by status
`queueId`	Yes	Category queue ID
`locationId`	Yes	Location ID

fetch_category_queuesTry in Inspector

List all category queues with pagination

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of queues to skip
`limit`	No	Number of queues to return
`categoryId`	No	Filter by category ID
`locationId`	Yes	Location ID

filter_users_by_emailTry in Inspector

Filter users by a list of email addresses. Useful for bulk user lookups by email.

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of results to skip (default: "0")
`limit`	No	Number of results to return (default: "25")
`emails`	Yes	Array of email addresses to filter. Example: ["user1@example.com", "user2@example.com"]
`deleted`	No	Include deleted users (default: false)
`companyId`	Yes	Company/Agency ID (required). Example: "5DP41231LkQsiKESj6rh"
`projection`	No	Fields to return. Use "all" for all fields, or comma-separated field names. Default returns only id and email

finalize_csvTry in Inspector

Finalize a CSV import process

ParametersJSON Schema

Name	Required	Description	Default
`csvId`	Yes	CSV import ID
`userId`	No	User ID finalizing the import

generate_estimate_numberTry in Inspector

Generate a unique estimate number

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID

generate_invoice_numberTry in Inspector

Generate a unique invoice number

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID

get_action_by_idTry in Inspector

Get detailed information about a specific action

ParametersJSON Schema

Name	Required	Description	Default
`agentId`	Yes	Unique identifier of the AI agent
`actionId`	Yes	Unique identifier of the action

get_agent_studio_agentTry in Inspector

Get a specific Agent Studio agent by ID

ParametersJSON Schema

Name	Required	Description	Default
`agentId`	Yes	The agent ID
`locationId`	No	The location ID (optional, uses default if not provided)

get_all_objectsTry in Inspector

Get all objects (custom and standard) for a location including contact, opportunity, business, and custom objects

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	Location ID (uses default if not provided)

get_app_configTry in Inspector

Get configuration for an installed app

ParametersJSON Schema

Name	Required	Description	Default
`appId`	Yes	App ID
`locationId`	No	Location ID (optional)

get_appointmentTry in Inspector

Get detailed information about a specific appointment by ID

ParametersJSON Schema

Name	Required	Description	Default
`appointmentId`	Yes	The unique ID of the appointment to retrieve

get_appointment_notesTry in Inspector

Get notes for an appointment

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of notes to return
`offset`	No	Number of notes to skip
`appointmentId`	Yes	Appointment ID

get_blocked_slotsTry in Inspector

Get blocked time slots for a location

ParametersJSON Schema

Name	Required	Description
`userId`	No	Filter by user ID
`endTime`	Yes	End time for the query range
`groupId`	No	Filter by group ID
`startTime`	Yes	Start time for the query range
`calendarId`	No	Filter by calendar ID

get_blog_authorsTry in Inspector

Get all available blog authors for the current location. Use this to find author IDs for creating blog posts.

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Number of authors to retrieve (default: 10)
`offset`	No	Number of authors to skip for pagination (default: 0)

get_blog_categoriesTry in Inspector

Get all available blog categories for the current location. Use this to find category IDs for creating blog posts.

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Number of categories to retrieve (default: 10)
`offset`	No	Number of categories to skip for pagination (default: 0)

get_blog_postsTry in Inspector

Get blog posts from a specific blog site. Use this to list and search existing blog posts.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Number of posts to retrieve (default: 10, max recommended: 50)
`blogId`	Yes	Blog site ID to get posts from (use get_blog_sites to find available blogs)
`offset`	No	Number of posts to skip for pagination (default: 0)
`status`	No	Optional filter by publication status
`searchTerm`	No	Optional search term to filter posts by title or content

get_blog_sitesTry in Inspector

Get all blog sites for the current location. Use this to find available blogs before creating or managing posts.

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of blogs to skip for pagination (default: 0)
`limit`	No	Number of blogs to retrieve (default: 10)
`searchTerm`	No	Optional search term to filter blogs by name

get_businessTry in Inspector

Get business details by ID

ParametersJSON Schema

Name	Required	Description	Default
`businessId`	Yes	Business ID

get_calendarTry in Inspector

Get detailed information about a specific calendar by ID

ParametersJSON Schema

Name	Required	Description	Default
`calendarId`	Yes	The unique ID of the calendar to retrieve

get_calendar_eventsTry in Inspector

Get appointments/events from calendars within a date range

ParametersJSON Schema

Name	Required	Description
`userId`	No	Filter events by assigned user ID
`endTime`	Yes	End time in milliseconds or ISO date (e.g., "2024-01-31" or "1706745599999")
`groupId`	No	Filter events by calendar group ID
`startTime`	Yes	Start time in milliseconds or ISO date (e.g., "2024-01-01" or "1704067200000")
`calendarId`	No	Filter events by specific calendar ID

get_calendar_groupsTry in Inspector

Get all calendar groups in the GoHighLevel location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	Optional location ID to override the default location configured in the server. If not provided, uses the location from configuration.

get_calendar_notificationTry in Inspector

Get specific calendar notification

ParametersJSON Schema

Name	Required	Description	Default
`calendarId`	Yes	Calendar ID
`notificationId`	Yes	Notification ID

get_calendar_notificationsTry in Inspector

Get calendar notifications

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number to skip
`limit`	No	Maximum number to return
`deleted`	No	Include deleted notifications
`isActive`	No	Filter by active status
`calendarId`	Yes	Calendar ID

get_calendar_resource_equipmentTry in Inspector

Get specific equipment resource details

ParametersJSON Schema

Name	Required	Description	Default
`resourceId`	Yes	Equipment resource ID

get_calendar_resource_roomTry in Inspector

Get specific room resource details

ParametersJSON Schema

Name	Required	Description	Default
`resourceId`	Yes	Room resource ID

get_calendar_resources_equipmentsTry in Inspector

Get calendar equipment resources

ParametersJSON Schema

Name	Required	Description	Default
`skip`	No	Number to skip
`limit`	No	Maximum number to return

get_calendar_resources_roomsTry in Inspector

Get calendar room resources

ParametersJSON Schema

Name	Required	Description	Default
`skip`	No	Number to skip
`limit`	No	Maximum number to return

get_calendarsTry in Inspector

Get all calendars in the GoHighLevel location with optional filtering

ParametersJSON Schema

Name	Required	Description	Default
`groupId`	No	Filter calendars by group ID
`showDrafted`	No	Include draft calendars (default: true)

get_campaignsTry in Inspector

Get all campaigns for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	The location ID (optional, uses default if not provided)

get_companyTry in Inspector

Get company details by ID

ParametersJSON Schema

Name	Required	Description	Default
`companyId`	Yes	Company ID

get_contactTry in Inspector

Get detailed information about a specific contact

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID

get_contact_appointmentsTry in Inspector

Get all appointments for a contact

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID

get_contact_noteTry in Inspector

Get a specific note for a contact

ParametersJSON Schema

Name	Required	Description	Default
`noteId`	Yes	Note ID
`contactId`	Yes	Contact ID

get_contact_notesTry in Inspector

Get all notes for a contact

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID

get_contacts_by_businessTry in Inspector

Get contacts associated with a specific business

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of results to skip
`limit`	No	Maximum number of results
`query`	No	Search query
`businessId`	Yes	Business ID

get_contact_taskTry in Inspector

Get a specific task for a contact

ParametersJSON Schema

Name	Required	Description	Default
`taskId`	Yes	Task ID
`contactId`	Yes	Contact ID

get_contact_tasksTry in Inspector

Get all tasks for a contact

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID

get_conversationTry in Inspector

Get detailed conversation information including message history

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of messages to return (default: 20)
`messageTypes`	No	Filter messages by type (optional)
`conversationId`	Yes	The unique ID of the conversation to retrieve

get_conversation_ai_agentTry in Inspector

Get detailed information about a specific AI agent

ParametersJSON Schema

Name	Required	Description	Default
`agentId`	Yes	Unique identifier of the AI agent

get_couponTry in Inspector

Get coupon details by ID or code

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Coupon ID
`code`	Yes	Coupon code
`altId`	Yes	Location ID
`altType`	Yes	Alt Type

get_courseTry in Inspector

Get details of a specific course

ParametersJSON Schema

Name	Required	Description	Default
`courseId`	Yes	Course ID

get_course_import_statusTry in Inspector

Get import status of a course

ParametersJSON Schema

Name	Required	Description	Default
`importId`	Yes	Import ID

get_coursesTry in Inspector

Get all courses for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	Location ID (optional)

get_crawling_statusTry in Inspector

Get the status of the latest crawling operation

ParametersJSON Schema

Name	Required	Description	Default
`knowledgeBaseId`	Yes	The knowledge base ID

get_csv_postTry in Inspector

Get posts from a CSV import

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of posts to skip
`csvId`	Yes	CSV import ID
`limit`	No	Number of posts to return

get_csv_upload_statusTry in Inspector

Get status of CSV uploads

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number to skip
`limit`	No	Number to return
`userId`	No	Filter by user ID
`includeUsers`	No	Include user data

get_custom_menusTry in Inspector

Get all custom menus for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	Location ID (optional)

get_custom_provider_configTry in Inspector

Fetch existing payment config for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	Location ID

get_duplicate_contactTry in Inspector

Check for duplicate contacts by email or phone

ParametersJSON Schema

Name	Required	Description	Default
`email`	No	Email to check for duplicates
`phone`	No	Phone to check for duplicates

get_email_campaignsTry in Inspector

Get a list of email campaigns from GoHighLevel.

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of campaigns to return.
`offset`	No	Number of campaigns to skip for pagination.
`status`	No	Filter campaigns by status.	active

get_email_messageTry in Inspector

Get detailed email message information by email message ID

ParametersJSON Schema

Name	Required	Description	Default
`emailMessageId`	Yes	The unique ID of the email message to retrieve

get_email_templatesTry in Inspector

Get a list of email templates from GoHighLevel.

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of templates to return.
`offset`	No	Number of templates to skip for pagination.

get_estimateTry in Inspector

Get estimate by ID

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`estimateId`	Yes	Estimate ID

get_formsTry in Inspector

Get all forms for a location

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of forms to skip for pagination
`limit`	No	Number of forms to return (max 100)
`locationId`	No	Location ID (optional)

get_form_submissionsTry in Inspector

Get submissions for a specific form

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of submissions to skip
`endAt`	No	End date for submissions (ISO 8601)
`limit`	No	Number of submissions to return
`formId`	Yes	Form ID
`startAt`	No	Start date for submissions (ISO 8601)
`locationId`	No	Location ID

get_free_slotsTry in Inspector

Get available time slots for booking appointments on a specific calendar

ParametersJSON Schema

Name	Required	Description
`userId`	No	Specific user ID to check availability for
`endDate`	Yes	End date for availability check (YYYY-MM-DD format or milliseconds)
`timezone`	No	Timezone for the results (e.g., "America/New_York")
`startDate`	Yes	Start date for availability check (YYYY-MM-DD format or milliseconds)
`calendarId`	Yes	The calendar ID to check availability for

get_funnel_page_redirectsTry in Inspector

Get redirects for a funnel page

ParametersJSON Schema

Name	Required	Description
`pageId`	Yes	Page ID
`funnelId`	Yes	Funnel ID
`locationId`	No	Location ID (optional)

get_funnel_pagesTry in Inspector

Get all pages for a funnel

ParametersJSON Schema

Name	Required	Description	Default
`funnelId`	Yes	Funnel ID
`locationId`	No	Location ID (optional)

get_funnelsTry in Inspector

Get all funnels for a location

ParametersJSON Schema

Name	Required	Description
`limit`	No	Number of funnels to return
`offset`	No	Number of funnels to skip
`locationId`	No	Location ID (optional)

get_generation_detailsTry in Inspector

Get detailed information about an AI-generated response including system prompt, conversation history, and knowledge base chunks used

ParametersJSON Schema

Name	Required	Description	Default
`generationId`	Yes	Unique identifier of the AI generation

get_installed_appsTry in Inspector

Get all installed marketplace apps for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	Location ID (optional)

get_invoiceTry in Inspector

Get invoice by ID

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`invoiceId`	Yes	Invoice ID

get_invoice_scheduleTry in Inspector

Get invoice schedule by ID

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`scheduleId`	Yes	Schedule ID

get_invoice_templateTry in Inspector

Get invoice template by ID

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`templateId`	Yes	Template ID

get_knowledge_baseTry in Inspector

Get a knowledge base by ID

ParametersJSON Schema

Name	Required	Description	Default
`knowledgeBaseId`	Yes	The knowledge base ID

get_last_snapshot_pushTry in Inspector

Get the last snapshot push for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	Location ID

get_linksTry in Inspector

Get all trigger links for a location

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of links to skip
`limit`	No	Number of links to return
`locationId`	No	Location ID (optional)

get_locationTry in Inspector

Get detailed information about a specific location/sub-account by ID

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The unique ID of the location to retrieve

get_location_custom_fieldTry in Inspector

Get a specific custom field by ID

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The location ID
`customFieldId`	Yes	The custom field ID to retrieve

get_location_custom_fieldsTry in Inspector

Get custom fields for a location, optionally filtered by model type

ParametersJSON Schema

Name	Required	Description	Default
`model`	No	Filter by model type (default: all)	all
`locationId`	Yes	The location ID

get_location_custom_valueTry in Inspector

Get a specific custom value by ID

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The location ID
`customValueId`	Yes	The custom value ID to retrieve

get_location_custom_valuesTry in Inspector

Get all custom values for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The location ID

get_location_tagTry in Inspector

Get a specific location tag by ID

ParametersJSON Schema

Name	Required	Description	Default
`tagId`	Yes	The tag ID to retrieve
`locationId`	Yes	The location ID

get_location_tagsTry in Inspector

Get all tags for a specific location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	The location ID to get tags from

get_location_templatesTry in Inspector

Get SMS/Email templates for a location

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number to skip for pagination (default: 0)
`type`	No	Filter by template type
`limit`	No	Maximum number to return (default: 25)
`deleted`	No	Include deleted templates (default: false)
`originId`	Yes	Origin ID (required parameter)
`locationId`	Yes	The location ID

get_media_filesTry in Inspector

Get list of files and folders from the media library with filtering and search capabilities

ParametersJSON Schema

Name	Required	Description	Default
`type`	No	Filter by type (file or folder)
`altId`	No	Location or Agency ID (uses default location if not provided)
`limit`	No	Number of files to show in the listing (max 100)
`query`	No	Search query text to filter files by name
`offset`	No	Number of files to skip in listing
`sortBy`	No	Field to sort the file listing by (e.g., createdAt, name, size)	createdAt
`altType`	No	Context type (location or agency)	location
`parentId`	No	Parent folder ID to list files within a specific folder
`sortOrder`	No	Direction to sort files (asc or desc)	desc

get_messageTry in Inspector

Get detailed message information by message ID

ParametersJSON Schema

Name	Required	Description	Default
`messageId`	Yes	The unique ID of the message to retrieve

get_message_recordingTry in Inspector

Get call recording audio for a message

ParametersJSON Schema

Name	Required	Description	Default
`messageId`	Yes	The unique ID of the call message to get recording for

get_message_transcriptionTry in Inspector

Get call transcription text for a message

ParametersJSON Schema

Name	Required	Description	Default
`messageId`	Yes	The unique ID of the call message to get transcription for

get_object_recordTry in Inspector

Get a specific record by ID from a custom or standard object

ParametersJSON Schema

Name	Required	Description	Default
`recordId`	Yes	ID of the record to retrieve
`schemaKey`	Yes	Schema key of the object

get_object_schemaTry in Inspector

Get object schema details by key including all fields and properties for custom or standard objects

ParametersJSON Schema

Name	Required	Description
`key`	Yes	Object key (e.g., "custom_objects.pet" for custom objects, "contact" for standard objects)
`locationId`	No	Location ID (uses default if not provided)
`fetchProperties`	No	Whether to fetch all standard/custom fields of the object

get_opportunityTry in Inspector

Get detailed information about a specific opportunity by ID

ParametersJSON Schema

Name	Required	Description	Default
`opportunityId`	Yes	The unique ID of the opportunity to retrieve

get_order_by_idTry in Inspector

Get a specific order by its ID

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Alt ID (unique identifier like location ID)
`altType`	Yes	Alt Type (type of identifier)
`orderId`	Yes	ID of the order to retrieve
`locationId`	No	Location ID (sub-account ID)

get_pipelinesTry in Inspector

Get all sales pipelines configured in GoHighLevel

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	Optional location ID to override the default location configured in the server. If not provided, uses the location from configuration.

get_platform_accountsTry in Inspector

Get available accounts for a specific platform after OAuth

ParametersJSON Schema

Name	Required	Description	Default
`platform`	Yes	Social media platform
`accountId`	Yes	OAuth account ID

get_recent_messagesTry in Inspector

Get recent messages across all conversations for monitoring

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of conversations to check (default: 10)
`status`	No	Filter by conversation status	unread

get_snapshotsTry in Inspector

Get all available snapshots

ParametersJSON Schema

Name	Required	Description	Default
`skip`	No	Number of snapshots to skip
`limit`	No	Number of snapshots to return

get_snapshot_statusTry in Inspector

Get the status of a snapshot push operation

ParametersJSON Schema

Name	Required	Description	Default
`pushId`	Yes	Push operation ID
`locationId`	Yes	Location ID

get_social_accountsTry in Inspector

Get all connected social media accounts and groups

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	Optional location ID to override the default location configured in the server. If not provided, uses the location from configuration.

get_social_categoriesTry in Inspector

Get social media post categories

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number to skip
`limit`	No	Number to return
`searchText`	No	Search for categories

get_social_categoryTry in Inspector

Get a specific social media category by ID

ParametersJSON Schema

Name	Required	Description	Default
`categoryId`	Yes	Category ID

get_social_postTry in Inspector

Get details of a specific social media post

ParametersJSON Schema

Name	Required	Description	Default
`postId`	Yes	Social media post ID

get_social_statisticsTry in Inspector

Get social media statistics for accounts. Provides metrics for the last 7 days with comparison to the previous 7 days.

ParametersJSON Schema

Name	Required	Description
`platforms`	No	Array of platform names to filter by (e.g., facebook, instagram, twitter)
`accountIds`	No	Array of account IDs to filter by
`locationId`	Yes	Location ID

get_social_tagsTry in Inspector

Get social media post tags

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number to skip
`limit`	No	Number to return
`searchText`	No	Search for tags

get_social_tags_by_idsTry in Inspector

Get specific social media tags by their IDs

ParametersJSON Schema

Name	Required	Description	Default
`tagIds`	Yes	Array of tag IDs

get_subscription_by_idTry in Inspector

Get a specific subscription by its ID

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Alt ID (unique identifier like location ID)
`altType`	Yes	Alt Type
`subscriptionId`	Yes	ID of the subscription to retrieve

get_timezonesTry in Inspector

Get available timezones for location configuration

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	Optional location ID

get_trained_pagesTry in Inspector

Get all trained page links for a knowledge base

ParametersJSON Schema

Name	Required	Description	Default
`knowledgeBaseId`	Yes	The knowledge base ID

get_transaction_by_idTry in Inspector

Get a specific transaction by its ID

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Alt ID (unique identifier like location ID)
`altType`	Yes	Alt Type (type of identifier)
`locationId`	No	Location ID (sub-account ID)
`transactionId`	Yes	ID of the transaction to retrieve

get_userTry in Inspector

Get user details by ID. Returns user information including name, email, phone, permissions, roles, and scopes.

ParametersJSON Schema

Name	Required	Description	Default
`userId`	Yes	User ID (e.g., "ve9EPM428h8vShlRW1KT")

get_users_by_locationTry in Inspector

Get all users for a specific location/sub-account. Returns list of users assigned to the location.

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	Location/Sub-account ID (required). Example: "s4BtzHFWmT28mbb85uPa"

get_voice_ai_agentTry in Inspector

Retrieve detailed configuration and settings for a specific Voice AI agent

ParametersJSON Schema

Name	Required	Description	Default
`agentId`	Yes	Unique identifier of the Voice AI agent

ghl_create_associationTry in Inspector

Create a new association that defines relationship types between entities like contacts, custom objects, and opportunities.

ParametersJSON Schema

Name	Required	Description
`key`	Yes	Unique key for the association (e.g., "student_teacher")
`locationId`	No	GoHighLevel location ID (will use default if not provided)
`firstObjectKey`	Yes	Key for the first object (e.g., "custom_objects.children")
`secondObjectKey`	Yes	Key for the second object (e.g., "contact")
`firstObjectLabel`	Yes	Label for the first object in the association (e.g., "student")
`secondObjectLabel`	Yes	Label for the second object in the association (e.g., "teacher")

ghl_create_custom_fieldTry in Inspector

Create a new custom field for custom objects or company (business). Supports various field types including text, number, options, date, file upload, etc.

ParametersJSON Schema

Name	Required	Description
`name`	No	Field name (optional for some field types)
`options`	No	Options for the field (required for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST types)
`dataType`	Yes	Type of field to create
`fieldKey`	Yes	Field key. Format: "custom_object.{objectKey}.{fieldKey}" for custom objects. Example: "custom_object.pet.name"
`parentId`	Yes	ID of the parent folder for organization
`objectKey`	Yes	The object key. Format: "custom_object.{objectKey}" for custom objects. Example: "custom_object.pet"
`locationId`	No	GoHighLevel location ID (will use default if not provided)
`description`	No	Description of the field
`placeholder`	No	Placeholder text for the field
`showInForms`	No	Whether the field should be shown in forms
`maxFileLimit`	No	Maximum file limit for uploads (only for FILE_UPLOAD type)
`acceptedFormats`	No	Allowed file formats for uploads (only for FILE_UPLOAD type)
`allowCustomOption`	No	Allow users to add custom option values for RADIO type fields

ghl_create_custom_field_folderTry in Inspector

Create a new custom field folder for organizing fields within an object.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the folder
`objectKey`	Yes	Object key for the folder. Format: "custom_object.{objectKey}" for custom objects. Example: "custom_object.pet"
`locationId`	No	GoHighLevel location ID (will use default if not provided)

ghl_create_priceTry in Inspector

Create a price for a product

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Price name/variant name
`type`	Yes	Price type
`amount`	Yes	Price amount in cents
`currency`	Yes	Currency code (e.g., USD)
`productId`	Yes	Product ID to create price for
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`compareAtPrice`	No	Compare at price (for discounts)

ghl_create_productTry in Inspector

Create a new product in GoHighLevel

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Product name
`slug`	No	Product URL slug
`image`	No	Product image URL
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`description`	No	Product description
`productType`	Yes	Type of product
`availableInStore`	No	Whether product is available in store

ghl_create_product_collectionTry in Inspector

Create a new product collection

ParametersJSON Schema

Name	Required	Description
`seo`	No
`name`	Yes	Collection name
`slug`	Yes	Collection URL slug
`image`	No	Collection image URL
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_create_relationTry in Inspector

Create a relation between two entities using an existing association. Links specific records together.

ParametersJSON Schema

Name	Required	Description
`locationId`	No	GoHighLevel location ID (will use default if not provided)
`associationId`	Yes	The ID of the association to use for this relation
`firstRecordId`	Yes	ID of the first record (e.g., contact ID if contact is first object in association)
`secondRecordId`	Yes	ID of the second record (e.g., custom object record ID if custom object is second object)

ghl_create_shipping_carrierTry in Inspector

Create a new shipping carrier for dynamic rate calculation

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the shipping carrier
`services`	Yes	Array of available services
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`callbackUrl`	Yes	Callback URL for carrier rate requests

ghl_create_shipping_rateTry in Inspector

Create a new shipping rate for a shipping zone

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the shipping rate
`amount`	Yes	Shipping rate amount
`currency`	Yes	Currency code (e.g., USD)
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`conditionType`	Yes	Condition type for rate calculation
`shippingZoneId`	Yes	ID of the shipping zone

ghl_create_shipping_zoneTry in Inspector

Create a new shipping zone with specific countries and states

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the shipping zone
`countries`	Yes	Array of countries with optional state restrictions
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_create_store_settingTry in Inspector

Create or update store settings including shipping origin and notifications

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingOrigin`	Yes	Shipping origin address details

ghl_delete_associationTry in Inspector

Delete a user-defined association. This will also delete all relations created with this association.

ParametersJSON Schema

Name	Required	Description	Default
`associationId`	Yes	The ID of the association to delete

ghl_delete_custom_fieldTry in Inspector

Delete a custom field by ID. This will permanently remove the field and its data.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	The ID of the custom field to delete

ghl_delete_custom_field_folderTry in Inspector

Delete a custom field folder. This will also affect any fields within the folder.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	The ID of the folder to delete
`locationId`	No	GoHighLevel location ID (will use default if not provided)

ghl_delete_productTry in Inspector

Delete a product by ID

ParametersJSON Schema

Name	Required	Description	Default
`productId`	Yes	Product ID to delete
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_delete_relationTry in Inspector

Delete a specific relation between two entities.

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GoHighLevel location ID (will use default if not provided)
`relationId`	Yes	The ID of the relation to delete

ghl_delete_shipping_carrierTry in Inspector

Delete a shipping carrier

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingCarrierId`	Yes	ID of the shipping carrier to delete

ghl_delete_shipping_rateTry in Inspector

Delete a shipping rate

ParametersJSON Schema

Name	Required	Description
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingRateId`	Yes	ID of the shipping rate to delete
`shippingZoneId`	Yes	ID of the shipping zone

ghl_delete_shipping_zoneTry in Inspector

Delete a shipping zone and all its associated shipping rates

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingZoneId`	Yes	ID of the shipping zone to delete

ghl_get_all_associationsTry in Inspector

Get all associations for a sub-account/location with pagination. Returns system-defined and user-defined associations.

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of records to skip for pagination
`limit`	No	Maximum number of records to return (max 100)
`locationId`	No	GoHighLevel location ID (will use default if not provided)

ghl_get_association_by_idTry in Inspector

Get a specific association by its ID. Works for both system-defined and user-defined associations.

ParametersJSON Schema

Name	Required	Description	Default
`associationId`	Yes	The ID of the association to retrieve

ghl_get_association_by_keyTry in Inspector

Get an association by its key name. Useful for finding both standard and user-defined associations.

ParametersJSON Schema

Name	Required	Description	Default
`keyName`	Yes	The key name of the association to retrieve
`locationId`	No	GoHighLevel location ID (will use default if not provided)

ghl_get_association_by_object_keyTry in Inspector

Get associations by object keys like contacts, custom objects, and opportunities.

ParametersJSON Schema

Name	Required	Description	Default
`objectKey`	Yes	The object key to search for (e.g., "custom_objects.car", "contact", "opportunity")
`locationId`	No	GoHighLevel location ID (optional)

ghl_get_available_shipping_ratesTry in Inspector

Get available shipping rates for an order based on destination and order details

ParametersJSON Schema

Name	Required	Description
`address`	Yes	Shipping address details
`country`	Yes	Destination country code
`products`	Yes	Array of products in the order
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`totalOrderAmount`	Yes	Total order amount
`totalOrderWeight`	Yes	Total order weight

ghl_get_custom_field_by_idTry in Inspector

Get a custom field or folder by its ID. Supports custom objects and company (business) fields.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	The ID of the custom field or folder to retrieve

ghl_get_custom_fields_by_object_keyTry in Inspector

Get all custom fields and folders for a specific object key (e.g., custom object or company).

ParametersJSON Schema

Name	Required	Description	Default
`objectKey`	Yes	Object key to get fields for. Format: "custom_object.{objectKey}" for custom objects. Example: "custom_object.pet"
`locationId`	No	GoHighLevel location ID (will use default if not provided)

ghl_get_productTry in Inspector

Get a specific product by ID

ParametersJSON Schema

Name	Required	Description	Default
`productId`	Yes	Product ID to retrieve
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_get_relations_by_recordTry in Inspector

Get all relations for a specific record ID with pagination and optional filtering by association IDs.

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of records to skip for pagination
`limit`	No	Maximum number of records to return
`recordId`	Yes	The record ID to get relations for
`locationId`	No	GoHighLevel location ID (will use default if not provided)
`associationIds`	No	Optional array of association IDs to filter relations

ghl_get_shipping_carrierTry in Inspector

Get details of a specific shipping carrier

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingCarrierId`	Yes	ID of the shipping carrier to retrieve

ghl_get_shipping_rateTry in Inspector

Get details of a specific shipping rate

ParametersJSON Schema

Name	Required	Description
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingRateId`	Yes	ID of the shipping rate to retrieve
`shippingZoneId`	Yes	ID of the shipping zone

ghl_get_shipping_zoneTry in Inspector

Get details of a specific shipping zone

ParametersJSON Schema

Name	Required	Description
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingZoneId`	Yes	ID of the shipping zone to retrieve
`withShippingRate`	No	Include shipping rates in response (optional)

ghl_get_store_settingTry in Inspector

Get current store settings

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_get_surveysTry in Inspector

Retrieve all surveys for a location. Surveys are used to collect information from contacts through forms and questionnaires.

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of records to skip for pagination (default: 0)
`type`	No	Filter surveys by type (e.g., "folder")
`limit`	No	Maximum number of surveys to return (max: 50, default: 10)
`locationId`	No	The location ID to get surveys for. If not provided, uses the default location from configuration.

ghl_get_survey_submissionsTry in Inspector

Retrieve survey submissions with advanced filtering and pagination. Get responses from contacts who have completed surveys.

ParametersJSON Schema

Name	Required	Description
`q`	No	Search by contact ID, name, email, or phone number
`page`	No	Page number for pagination (default: 1)
`endAt`	No	End date for filtering submissions (YYYY-MM-DD format)
`limit`	No	Number of submissions per page (max: 100, default: 20)
`startAt`	No	Start date for filtering submissions (YYYY-MM-DD format)
`surveyId`	No	Filter submissions by specific survey ID
`locationId`	No	The location ID to get submissions for. If not provided, uses the default location from configuration.

ghl_get_workflowsTry in Inspector

Retrieve all workflows for a location. Workflows represent automation sequences that can be triggered by various events in the system.

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	The location ID to get workflows for. If not provided, uses the default location from configuration.

ghl_list_inventoryTry in Inspector

List inventory items with stock levels

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of items to return
`offset`	No	Number of items to skip
`search`	No	Search term for inventory items
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_list_pricesTry in Inspector

List prices for a product

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of prices to return
`offset`	No	Number of prices to skip
`productId`	Yes	Product ID to list prices for
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_list_product_collectionsTry in Inspector

List product collections

ParametersJSON Schema

Name	Required	Description
`name`	No	Search by collection name
`limit`	No	Maximum number of collections to return
`offset`	No	Number of collections to skip
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_list_productsTry in Inspector

List products with optional filtering

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of products to return
`offset`	No	Number of products to skip
`search`	No	Search term for product names
`storeId`	No	Filter by store ID
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`includedInStore`	No	Filter by store inclusion status
`availableInStore`	No	Filter by store availability

ghl_list_shipping_carriersTry in Inspector

List all shipping carriers for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GHL Location ID (optional, uses default if not provided)

ghl_list_shipping_ratesTry in Inspector

List all shipping rates for a specific shipping zone

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingZoneId`	Yes	ID of the shipping zone

ghl_list_shipping_zonesTry in Inspector

List all shipping zones for a location

ParametersJSON Schema

Name	Required	Description
`limit`	No	Number of zones to return (optional)
`offset`	No	Number of zones to skip (optional)
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`withShippingRate`	No	Include shipping rates in response (optional)

ghl_update_associationTry in Inspector

Update the labels of an existing association. Only user-defined associations can be updated.

ParametersJSON Schema

Name	Required	Description
`associationId`	Yes	The ID of the association to update
`firstObjectLabel`	Yes	New label for the first object in the association
`secondObjectLabel`	Yes	New label for the second object in the association

ghl_update_custom_fieldTry in Inspector

Update an existing custom field by ID. Can modify name, description, options, and other properties.

ParametersJSON Schema

Name	Required	Description
`id`	Yes	The ID of the custom field to update
`name`	No	Updated field name
`options`	No	Updated options (replaces all existing options - include all options you want to keep)
`locationId`	No	GoHighLevel location ID (will use default if not provided)
`description`	No	Updated description of the field
`placeholder`	No	Updated placeholder text for the field
`showInForms`	No	Whether the field should be shown in forms
`maxFileLimit`	No	Updated maximum file limit for uploads
`acceptedFormats`	No	Updated allowed file formats for uploads

ghl_update_custom_field_folderTry in Inspector

Update the name of an existing custom field folder.

ParametersJSON Schema

Name	Required	Description
`id`	Yes	The ID of the folder to update
`name`	Yes	New name for the folder
`locationId`	No	GoHighLevel location ID (will use default if not provided)

ghl_update_productTry in Inspector

Update an existing product

ParametersJSON Schema

Name	Required	Description
`name`	No	Product name
`image`	No	Product image URL
`productId`	Yes	Product ID to update
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`description`	No	Product description
`productType`	No	Type of product
`availableInStore`	No	Whether product is available in store

ghl_update_shipping_carrierTry in Inspector

Update a shipping carrier's properties

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingCarrierId`	Yes	ID of the shipping carrier to update

ghl_update_shipping_rateTry in Inspector

Update a shipping rate's properties

ParametersJSON Schema

Name	Required	Description
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingRateId`	Yes	ID of the shipping rate to update
`shippingZoneId`	Yes	ID of the shipping zone

ghl_update_shipping_zoneTry in Inspector

Update a shipping zone's name or countries

ParametersJSON Schema

Name	Required	Description
`name`	No	New name for the shipping zone (optional)
`countries`	No	Updated array of countries with optional state restrictions (optional)
`locationId`	No	GHL Location ID (optional, uses default if not provided)
`shippingZoneId`	Yes	ID of the shipping zone to update

list_actions_for_agentTry in Inspector

List all actions attached to an AI agent

ParametersJSON Schema

Name	Required	Description	Default
`agentId`	Yes	Unique identifier of the AI agent

list_active_numbersTry in Inspector

List active phone numbers for a location with pagination

ParametersJSON Schema

Name	Required	Description
`limit`	No	Number of phone numbers to return
`offset`	No	Number of phone numbers to skip for pagination
`locationId`	No	The location ID (optional, uses default if not provided)
`excludePoolAssignment`	No	Exclude number pool assignments from results

list_agent_studio_agentsTry in Inspector

List all active Agent Studio agents for a location with pagination

ParametersJSON Schema

Name	Required	Description
`limit`	No	Number of agents to return
`offset`	No	Number of agents to skip for pagination
`locationId`	No	The location ID (optional, uses default if not provided)

list_couponsTry in Inspector

List all coupons for a location with optional filtering

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Location ID
`limit`	No	Maximum number of coupons to return
`offset`	No	Number of coupons to skip for pagination
`search`	No	Search term to filter coupons by name or code
`status`	No	Filter coupons by status
`altType`	Yes	Alt Type

list_documentsTry in Inspector

List all documents/contracts for a location

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of documents to skip for pagination
`limit`	No	Number of documents to return
`locationId`	No	The location ID (optional, uses default if not provided)

list_estimatesTry in Inspector

List all estimates

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`limit`	Yes	Number of results per page	10
`offset`	Yes	Offset for pagination	0
`search`	No	Search term
`status`	No	Filter by status
`contactId`	No	Filter by contact ID

list_faqsTry in Inspector

Get all FAQs for a knowledge base with pagination

ParametersJSON Schema

Name	Required	Description
`limit`	No	Number of FAQs to return
`lastFaqId`	No	Last FAQ ID for pagination
`knowledgeBaseId`	Yes	The knowledge base ID

list_invoicesTry in Inspector

List all invoices

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`limit`	Yes	Number of results per page	10
`offset`	Yes	Offset for pagination	0
`search`	No	Search term
`status`	No	Filter by status
`contactId`	No	Filter by contact ID

list_invoice_schedulesTry in Inspector

List all invoice schedules

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`limit`	Yes	Number of results per page	10
`offset`	Yes	Offset for pagination	0
`search`	No	Search term
`status`	No	Filter by status

list_invoice_templatesTry in Inspector

List all invoice templates

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`limit`	Yes	Number of results per page	10
`offset`	Yes	Offset for pagination	0
`search`	No	Search term
`status`	No	Filter by status
`paymentMode`	No	Payment mode

list_knowledge_basesTry in Inspector

Get all knowledge bases for a location with pagination

ParametersJSON Schema

Name	Required	Description
`limit`	No	Number of knowledge bases to return
`locationId`	No	The location ID (optional, uses default if not provided)
`lastKnowledgeBaseId`	No	Last knowledge base ID for pagination

list_number_poolsTry in Inspector

Get list of number pools for a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	No	The location ID (optional, uses default if not provided)

list_order_fulfillmentsTry in Inspector

List all fulfillments for an order

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Location ID or Agency ID
`altType`	Yes	Alt Type
`orderId`	Yes	ID of the order

list_ordersTry in Inspector

List orders with optional filtering and pagination

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Alt ID (unique identifier like location ID)
`endAt`	No	Ending date interval for orders (YYYY-MM-DD)
`limit`	No	Maximum number of items per page
`offset`	No	Starting index for pagination
`search`	No	Search term for order name
`status`	No	Order status filter
`altType`	Yes	Alt Type (type of identifier)
`startAt`	No	Starting date interval for orders (YYYY-MM-DD)
`contactId`	No	Contact ID for filtering orders
`locationId`	No	Location ID (sub-account ID)
`paymentMode`	No	Mode of payment (live/test)
`funnelProductIds`	No	Comma-separated funnel product IDs

list_subscriptionsTry in Inspector

List subscriptions with optional filtering and pagination

ParametersJSON Schema

Name	Required	Description
`id`	No	Subscription ID for filtering
`altId`	Yes	Alt ID (unique identifier like location ID)
`endAt`	No	Ending date interval for subscriptions (YYYY-MM-DD)
`limit`	No	Maximum number of items per page
`offset`	No	Starting index for pagination
`search`	No	Search term for subscription name
`altType`	Yes	Alt Type
`startAt`	No	Starting date interval for subscriptions (YYYY-MM-DD)
`entityId`	No	Entity ID for filtering subscriptions
`contactId`	No	Contact ID for the subscription
`paymentMode`	No	Mode of payment (live/test)
`entitySourceType`	No	Source of the subscriptions

list_templatesTry in Inspector

List all document/contract templates for a location

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of templates to skip for pagination
`limit`	No	Number of templates to return
`locationId`	No	The location ID (optional, uses default if not provided)

list_transactionsTry in Inspector

List transactions with optional filtering and pagination

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Alt ID (unique identifier like location ID)
`endAt`	No	Ending date interval for transactions (YYYY-MM-DD)
`limit`	No	Maximum number of items per page
`offset`	No	Starting index for pagination
`search`	No	Search term for transaction name
`altType`	Yes	Alt Type (type of identifier)
`startAt`	No	Starting date interval for transactions (YYYY-MM-DD)
`entityId`	No	Entity ID for filtering transactions
`contactId`	No	Contact ID for filtering transactions
`locationId`	No	Location ID (sub-account ID)
`paymentMode`	No	Mode of payment (live/test)
`subscriptionId`	No	Subscription ID for filtering transactions
`entitySourceType`	No	Source of the transactions
`entitySourceSubType`	No	Source sub-type of the transactions

list_voice_ai_agentsTry in Inspector

Retrieve a paginated list of Voice AI agents for the location

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of results to return
`offset`	No	Number of results to skip for pagination

list_whitelabel_integration_providersTry in Inspector

List white-label integration providers with optional pagination

ParametersJSON Schema

Name	Required	Description
`altId`	Yes	Location ID or company ID based on altType
`limit`	No	Maximum number of items to return
`offset`	No	Starting index for pagination
`altType`	Yes	Alt Type

live_chat_typingTry in Inspector

Send typing indicator for live chat conversations

ParametersJSON Schema

Name	Required	Description
`isTyping`	Yes	Whether the agent is currently typing
`visitorId`	Yes	Unique visitor ID for the live chat session
`conversationId`	Yes	The conversation ID for the live chat

pause_saas_subscriptionTry in Inspector

Pause a SaaS subscription

ParametersJSON Schema

Name	Required	Description	Default
`companyId`	Yes	Company ID

push_snapshot_to_locationTry in Inspector

Push/deploy a snapshot to a location

ParametersJSON Schema

Name	Required	Description	Default
`locationId`	Yes	Target location ID
`snapshotId`	Yes	Snapshot/template ID to deploy

record_invoice_paymentTry in Inspector

Record a manual payment for an invoice

ParametersJSON Schema

Name	Required	Description
`card`	No	Card details (required if mode is card)
`mode`	Yes	Payment method/mode
`altId`	No	Location ID
`notes`	Yes	Payment notes
`amount`	No	Payment amount
`cheque`	No	Cheque details (required if mode is cheque)
`invoiceId`	Yes	Invoice ID

remove_contact_followersTry in Inspector

Remove followers from a contact

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID
`followers`	Yes	Array of user IDs to remove as followers

remove_contact_from_all_campaignsTry in Inspector

Remove contact from all campaigns

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID

remove_contact_from_campaignTry in Inspector

Remove contact from a specific campaign

ParametersJSON Schema

Name	Required	Description	Default
`contactId`	Yes	Contact ID
`campaignId`	Yes	Campaign ID

remove_contact_from_workflowTry in Inspector

Remove contact from a workflow

ParametersJSON Schema

Name	Required	Description
`contactId`	Yes	Contact ID
`workflowId`	Yes	Workflow ID
`eventStartTime`	No	Event start time (ISO format)

remove_contact_tagsTry in Inspector

Remove tags from a contact

ParametersJSON Schema

Name	Required	Description	Default
`tags`	Yes	Tags to remove
`contactId`	Yes	Contact ID

remove_opportunity_followersTry in Inspector

Remove followers from an opportunity

ParametersJSON Schema

Name	Required	Description	Default
`followers`	Yes	Array of user IDs to remove as followers
`opportunityId`	Yes	The unique ID of the opportunity

reset_category_queue_itemTry in Inspector

Reset a category queue item to its initial state

ParametersJSON Schema

Name	Required	Description
`itemId`	Yes	Queue item ID to reset
`queueId`	Yes	Category queue ID
`locationId`	Yes	Location ID

schedule_invoice_scheduleTry in Inspector

Start/schedule an invoice schedule

ParametersJSON Schema

Name	Required	Description
`altId`	No	Location ID
`startDate`	No	Start date for the schedule
`scheduleId`	Yes	Schedule ID

search_contactsTry in Inspector

Search for contacts with advanced filtering options

ParametersJSON Schema

Name	Required	Description
`email`	No	Filter by email address
`limit`	No	Maximum number of results (default: 25)
`phone`	No	Filter by phone number
`query`	No	Search query string

search_conversation_ai_agentsTry in Inspector

Search and filter AI agents by name and status

ParametersJSON Schema

Name	Required	Description
`name`	No	Filter agents by name (partial match supported)
`skip`	No	Number of results to skip for pagination
`limit`	No	Maximum number of results to return
`status`	No	Filter agents by status

search_conversationsTry in Inspector

Search conversations in GoHighLevel with various filters

ParametersJSON Schema

Name	Required	Description	Default
`limit`	No	Maximum number of conversations to return (default: 20, max: 100)
`query`	No	Search query to filter conversations
`status`	No	Filter conversations by read status	all
`contactId`	No	Filter conversations for a specific contact
`assignedTo`	No	Filter by user ID assigned to conversations

search_locationsTry in Inspector

Search for locations/sub-accounts in GoHighLevel with filtering options

ParametersJSON Schema

Name	Required	Description	Default
`skip`	No	Number of results to skip for pagination (default: 0)
`email`	No	Filter by email address
`limit`	No	Maximum number of locations to return (default: 10)
`order`	No	Order of results (default: asc)	asc
`companyId`	No	Company/Agency ID to filter locations

search_location_tasksTry in Inspector

Search tasks within a location with advanced filtering

ParametersJSON Schema

Name	Required	Description
`skip`	No	Number of tasks to skip for pagination (default: 0)
`limit`	No	Maximum number of tasks to return (default: 25)
`query`	No	Search query for task content
`completed`	No	Filter by completion status
`contactId`	No	Filter by specific contact IDs
`assignedTo`	No	Filter by assigned user IDs
`businessId`	No	Business ID filter
`locationId`	Yes	The location ID to search tasks in

search_object_recordsTry in Inspector

Search records within a custom or standard object using searchable properties

ParametersJSON Schema

Name	Required	Description
`page`	No	Page number for pagination
`query`	Yes	Search query using searchable properties (e.g., "name:Buddy" to search for records with name Buddy)
`pageLimit`	No	Number of records per page
`schemaKey`	Yes	Schema key of the object to search in
`locationId`	No	Location ID (uses default if not provided)
`searchAfter`	No	Cursor for pagination (returned from previous search)

search_opportunitiesTry in Inspector

Search for opportunities in GoHighLevel CRM using various filters like pipeline, stage, contact, status, etc.

ParametersJSON Schema

Name	Required	Description
`limit`	No	Maximum number of opportunities to return (default: 20, max: 100)
`query`	No	General search query (searches name, contact info)
`status`	No	Filter by opportunity status
`contactId`	No	Filter by specific contact ID
`assignedTo`	No	Filter by assigned user ID
`pipelineId`	No	Filter by specific pipeline ID
`pipelineStageId`	No	Filter by specific pipeline stage ID

search_social_postsTry in Inspector

Search and filter social media posts across all platforms

ParametersJSON Schema

Name	Required	Description	Default
`skip`	No	Number of posts to skip
`type`	No	Filter posts by status	all
`limit`	No	Number of posts to return
`toDate`	Yes	End date (ISO format)
`accounts`	No	Comma-separated account IDs to filter by
`fromDate`	Yes	Start date (ISO format)
`postType`	No	Type of post to search for
`includeUsers`	No	Include user data in response

search_usersTry in Inspector

Search users across the company/agency with various filters. Supports searching by name, email, phone, role, type, and more.

ParametersJSON Schema

Name	Required	Description
`ids`	No	Comma-separated list of User IDs to filter. Example: "5DP4iH6HLkQsiKESj6rh,5DP4iH6HLkQsiKESj34h"
`role`	No	Filter by user role. Example: "admin"
`skip`	No	Number of results to skip (default: "0")
`sort`	No	Field to sort by. Default is first and last name. Example: "dateAdded"
`type`	No	Filter by user type
`limit`	No	Number of results to return (default: "25")
`query`	No	Search term - matches against user full name, email, or phone. Example: "John"
`companyId`	Yes	Company/Agency ID to search within (required). Example: "5DP41231LkQsiKESj6rh"
`locationId`	No	Filter by specific location ID
`sortDirection`	No	Sort direction
`enabled2waySync`	No	Filter by 2-way sync enabled status

send_documentTry in Inspector

Send a document/contract to a client

ParametersJSON Schema

Name	Required	Description
`email`	No	The email address to send the document to (optional)
`contactId`	Yes	The contact ID to send the document to
`documentId`	Yes	The ID of the document to send
`locationId`	No	The location ID (optional, uses default if not provided)

send_emailTry in Inspector

Send an email message to a contact in GoHighLevel

ParametersJSON Schema

Name	Required	Description
`html`	No	HTML email content (optional, takes precedence over message)
`emailCc`	No	Optional: Array of CC email addresses
`message`	No	Plain text email content
`subject`	Yes	Email subject line
`emailBcc`	No	Optional: Array of BCC email addresses
`contactId`	Yes	The unique ID of the contact to send email to
`emailFrom`	No	Optional: Email address to send from (must be configured in GHL)
`attachments`	No	Optional: Array of attachment URLs

send_estimateTry in Inspector

Send an estimate to customer via email, SMS, or both

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`action`	Yes	How to send the estimate	email
`userId`	Yes	User ID sending the estimate
`liveMode`	Yes	Whether to send in live mode (true) or test mode (false)
`estimateId`	Yes	Estimate ID

send_invoiceTry in Inspector

Send an invoice to customer via email, SMS, or both

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID
`action`	Yes	How to send the invoice	email
`userId`	Yes	User ID sending the invoice
`liveMode`	Yes	Whether to send in live mode (true) or test mode (false)
`invoiceId`	Yes	Invoice ID

send_smsTry in Inspector

Send an SMS message to a contact in GoHighLevel

ParametersJSON Schema

Name	Required	Description
`message`	Yes	The SMS message content to send
`contactId`	Yes	The unique ID of the contact to send SMS to
`fromNumber`	No	Optional: Phone number to send from (must be configured in GHL)

send_templateTry in Inspector

Send a document/contract template to a client

ParametersJSON Schema

Name	Required	Description
`email`	No	The email address to send the template to (optional)
`contactId`	Yes	The contact ID to send the template to
`locationId`	No	The location ID (optional, uses default if not provided)
`templateId`	Yes	The ID of the template to send

set_csv_accountsTry in Inspector

Set accounts for CSV import processing

ParametersJSON Schema

Name	Required	Description
`userId`	No	User ID
`approver`	No	Approver user ID
`fileName`	Yes	CSV file name
`filePath`	Yes	CSV file path
`rowsCount`	Yes	Number of rows to process
`accountIds`	Yes	Account IDs for CSV import

start_social_oauthTry in Inspector

Start OAuth process for social media platform

ParametersJSON Schema

Name	Required	Description
`page`	No	Page context
`userId`	Yes	User ID initiating OAuth
`platform`	Yes	Social media platform
`reconnect`	No	Whether this is a reconnection

text2pay_invoiceTry in Inspector

Create or update text2pay invoice for SMS payment requests

ParametersJSON Schema

Name	Required	Description
`altId`	No	Location ID
`title`	Yes	Invoice title
`amount`	Yes	Invoice amount
`currency`	No	Currency code
`contactId`	Yes	Contact ID

train_discovered_urlsTry in Inspector

Train discovered website pages and ingest into the knowledge base

ParametersJSON Schema

Name	Required	Description	Default
`urls`	Yes	Array of URLs to train
`knowledgeBaseId`	Yes	The knowledge base ID

update_actionTry in Inspector

Update an existing action's configuration. The API accepts type, name, and details as required fields. NOTE: description, order, and enabled fields may be supported by the update endpoint but their acceptance should be verified against the current API version.

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Name of the action (3-50 characters)
`type`	Yes	Action type identifier
`order`	No	Optional execution order (⚠️ verify API support - may not be accepted by all API versions)
`agentId`	Yes	Unique identifier of the AI agent
`details`	Yes	Action-specific configuration object (see attach_action_to_agent for detailed field requirements per action type)
`enabled`	No	Optional enabled status (⚠️ verify API support - may not be accepted by all API versions)
`actionId`	Yes	Unique identifier of the action to update
`description`	No	Optional description (⚠️ verify API support - may not be accepted by all API versions)

update_appointmentTry in Inspector

Update an existing appointment in GoHighLevel

ParametersJSON Schema

Name	Required	Description
`title`	No	Updated title/subject of the appointment
`address`	No	Updated meeting location or address
`endTime`	No	Updated end time in ISO format
`toNotify`	No	Send notifications for this update
`startTime`	No	Updated start time in ISO format
`appointmentId`	Yes	The unique ID of the appointment to update
`assignedUserId`	No	Updated assigned user ID
`appointmentStatus`	No	Updated status of the appointment

update_appointment_noteTry in Inspector

Update an appointment note

ParametersJSON Schema

Name	Required	Description
`body`	Yes	Updated note content
`noteId`	Yes	Note ID
`userId`	No	User ID updating the note
`appointmentId`	Yes	Appointment ID

update_block_slotTry in Inspector

Update an existing blocked time slot

ParametersJSON Schema

Name	Required	Description
`title`	No	Updated title/reason for the block
`endTime`	No	Updated end time in ISO format
`startTime`	No	Updated start time in ISO format
`calendarId`	No	Updated calendar ID for the block
`blockSlotId`	Yes	The unique ID of the block slot to update
`assignedUserId`	No	Updated assigned user ID

update_blog_postTry in Inspector

Update an existing blog post in GoHighLevel. All fields except postId and blogId are optional.

ParametersJSON Schema

Name	Required	Description
`tags`	No	Updated array of tags
`title`	No	Updated blog post title
`author`	No	Updated author ID
`blogId`	Yes	Blog site ID that contains the post
`postId`	Yes	Blog post ID to update
`status`	No	Updated publication status
`content`	No	Updated HTML content of the blog post
`urlSlug`	No	Updated URL slug (use check_url_slug to verify availability)
`imageUrl`	No	Updated featured image URL
`categories`	No	Updated array of category IDs
`description`	No	Updated description/excerpt of the blog post
`publishedAt`	No	Updated ISO timestamp for publication date
`imageAltText`	No	Updated alt text for the featured image
`canonicalLink`	No	Updated canonical URL

update_businessTry in Inspector

Update business information

ParametersJSON Schema

Name	Required	Description
`name`	No	Business name
`email`	No	Business email
`phone`	No	Business phone
`website`	No	Business website
`businessId`	Yes	Business ID

update_calendarTry in Inspector

Update an existing calendar in GoHighLevel

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated name of the calendar
`slug`	No	Updated URL slug for the calendar
`groupId`	No	Updated calendar group ID
`isActive`	No	Updated active status
`openHours`	No	Updated weekly availability configuration for the calendar
`calendarId`	Yes	The unique ID of the calendar to update
`autoConfirm`	No	Updated auto-confirm setting
`description`	No	Updated description of the calendar
`teamMembers`	No	Updated team members assigned to the calendar
`slotDuration`	No	Updated duration of appointment slots in minutes
`availabilities`	No	Updated availability rules for the calendar (e.g., specific dates or recurring patterns)
`allowReschedule`	No	Updated reschedule permission setting
`slotDurationUnit`	No	Updated unit for slot duration
`allowCancellation`	No	Updated cancellation permission setting
`locationConfigurations`	No	Updated location-specific configurations for the calendar

update_calendar_groupTry in Inspector

Update calendar group details

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Group name
`slug`	Yes	URL slug for the group
`groupId`	Yes	Calendar group ID
`description`	Yes	Group description

update_calendar_notificationTry in Inspector

Update calendar notification

ParametersJSON Schema

Name	Required	Description
`body`	No	Notification body
`channel`	No	Notification channel
`deleted`	No	Whether notification is deleted
`subject`	No	Notification subject
`isActive`	No	Whether notification is active
`calendarId`	Yes	Calendar ID
`templateId`	No	Template ID
`receiverType`	No	Who receives the notification
`notificationId`	Yes	Notification ID
`notificationType`	No	Type of notification

update_calendar_resource_equipmentTry in Inspector

Update equipment resource details

ParametersJSON Schema

Name	Required	Description
`name`	No	Equipment name
`capacity`	No	Capacity per unit
`isActive`	No	Whether resource is active
`quantity`	No	Total quantity available
`resourceId`	Yes	Equipment resource ID
`calendarIds`	No	Associated calendar IDs
`description`	No	Equipment description
`outOfService`	No	Number currently out of service

update_calendar_resource_roomTry in Inspector

Update room resource details

ParametersJSON Schema

Name	Required	Description
`name`	No	Room name
`capacity`	No	Room capacity
`isActive`	No	Whether resource is active
`quantity`	No	Total quantity available
`resourceId`	Yes	Room resource ID
`calendarIds`	No	Associated calendar IDs
`description`	No	Room description
`outOfService`	No	Number currently out of service

update_category_queueTry in Inspector

Update category queue settings

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated queue name
`queueId`	Yes	Category queue ID
`isActive`	No	Whether queue is active
`accountIds`	No	Updated array of account IDs
`locationId`	Yes	Location ID
`scheduleDays`	No	Updated schedule days
`scheduleTime`	No	Updated schedule time
`scheduleType`	No	Updated schedule type

update_category_queue_itemTry in Inspector

Update a category queue item

ParametersJSON Schema

Name	Required	Description
`order`	No	Updated order position
`itemId`	Yes	Queue item ID
`status`	No	Updated item status
`queueId`	Yes	Category queue ID
`locationId`	Yes	Location ID
`scheduledDate`	No	Updated scheduled date (ISO format)

update_companyTry in Inspector

Update company information

ParametersJSON Schema

Name	Required	Description
`name`	No	Company name
`website`	No	Company website
`companyId`	Yes	Company ID

update_contactTry in Inspector

Update contact information

ParametersJSON Schema

Name	Required	Description
`tags`	No	Tags to assign to contact
`email`	No	Contact email address
`phone`	No	Contact phone number
`lastName`	No	Contact last name
`contactId`	Yes	Contact ID
`firstName`	No	Contact first name

update_contact_noteTry in Inspector

Update a note for a contact

ParametersJSON Schema

Name	Required	Description
`body`	Yes	Note content
`noteId`	Yes	Note ID
`userId`	No	User ID updating the note
`contactId`	Yes	Contact ID

update_contact_taskTry in Inspector

Update a task for a contact

ParametersJSON Schema

Name	Required	Description
`body`	No	Task description
`title`	No	Task title
`taskId`	Yes	Task ID
`dueDate`	No	Due date (ISO format)
`completed`	No	Task completion status
`contactId`	Yes	Contact ID
`assignedTo`	No	User ID to assign task to

update_conversationTry in Inspector

Update conversation properties (star, mark read, etc.)

ParametersJSON Schema

Name	Required	Description
`starred`	No	Star or unstar the conversation
`unreadCount`	No	Set the unread message count (0 to mark as read)
`conversationId`	Yes	The unique ID of the conversation to update

update_conversation_ai_agentTry in Inspector

Update an existing AI agent's configuration

ParametersJSON Schema

Name	Required	Description
`goal`	No	Updated goal of the agent
`mode`	No	Updated mode of operation
`name`	No	Updated name of the AI agent
`agentId`	Yes	Unique identifier of the AI agent to update
`channels`	No	Updated communication channels
`waitTime`	No	Updated wait time before agent responds
`isPrimary`	No	Updated primary agent status
`sleepTime`	No	Updated duration of sleep period
`personality`	No	Updated personality traits
`businessName`	No	Updated business name
`instructions`	No	Updated instructions for the agent
`sleepEnabled`	No	Updated sleep functionality status
`waitTimeUnit`	No	Updated wait time unit
`sleepTimeUnit`	No	Updated unit of sleep time
`respondToAudio`	No	Updated audio response setting
`respondToImages`	No	Updated image response setting
`knowledgeBaseIds`	No	Updated array of knowledge base IDs
`autoPilotMaxMessages`	No	Updated maximum messages in auto-pilot mode

update_couponTry in Inspector

Update an existing coupon

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Coupon ID
`code`	Yes	Coupon code
`name`	Yes	Coupon name
`altId`	Yes	Location ID
`altType`	Yes	Alt Type
`endDate`	No	End date in YYYY-MM-DDTHH:mm:ssZ format
`startDate`	Yes	Start date in YYYY-MM-DDTHH:mm:ssZ format
`productIds`	No	Product IDs that the coupon applies to
`usageLimit`	No	Maximum number of times coupon can be used
`discountType`	Yes	Type of discount
`discountValue`	Yes	Discount value
`limitPerCustomer`	No	Whether to limit coupon to once per customer
`applyToFuturePayments`	No	Whether coupon applies to future subscription payments
`applyToFuturePaymentsConfig`	No	Configuration for future payments application

update_custom_menuTry in Inspector

Update an existing custom menu

ParametersJSON Schema

Name	Required	Description
`name`	No	Menu name
`items`	No	Menu items
`menuId`	Yes	Menu ID
`locationId`	No	Location ID (optional)

update_email_templateTry in Inspector

Update an existing email template in GoHighLevel.

ParametersJSON Schema

Name	Required	Description
`html`	Yes	The updated HTML content of the template.
`templateId`	Yes	The ID of the template to update.
`previewText`	No	The updated preview text for the template.

update_estimateTry in Inspector

Update an existing estimate

ParametersJSON Schema

Name	Required	Description
`altId`	No	Location ID
`items`	No	Estimate items
`notes`	No	Estimate notes
`title`	No	Estimate title
`currency`	No	Currency code
`contactId`	No	Contact ID
`issueDate`	No	Issue date
`estimateId`	Yes	Estimate ID
`validUntil`	No	Valid until date

update_faqTry in Inspector

Update an existing FAQ

ParametersJSON Schema

Name	Required	Description
`faqId`	Yes	The FAQ ID
`answer`	No	Updated answer
`question`	No	Updated question
`knowledgeBaseId`	Yes	The knowledge base ID

update_followup_settingsTry in Inspector

Update the follow-up settings for an action

ParametersJSON Schema

Name	Required	Description
`agentId`	Yes	Unique identifier of the AI agent
`enabled`	No	Enable or disable follow-ups for this action
`message`	No	Follow-up message template
`actionId`	Yes	Unique identifier of the action
`delayMinutes`	No	Delay in minutes before sending follow-up
`maxFollowups`	No	Maximum number of follow-ups to send

update_invoiceTry in Inspector

Update an existing invoice

ParametersJSON Schema

Name	Required	Description
`altId`	No	Location ID
`items`	No	Invoice items
`notes`	No	Invoice notes
`title`	No	Invoice title
`dueDate`	No	Due date
`currency`	No	Currency code
`contactId`	No	Contact ID
`invoiceId`	Yes	Invoice ID
`issueDate`	No	Issue date

update_invoice_scheduleTry in Inspector

Update an existing invoice schedule

ParametersJSON Schema

Name	Required	Description
`name`	No	Schedule name
`altId`	No	Location ID
`contactId`	No	Contact ID
`frequency`	No	Schedule frequency
`scheduleId`	Yes	Schedule ID
`templateId`	No	Template ID

update_invoice_templateTry in Inspector

Update an existing invoice template

ParametersJSON Schema

Name	Required	Description
`name`	No	Template name
`altId`	No	Location ID
`title`	No	Invoice title
`currency`	No	Currency code
`templateId`	Yes	Template ID

update_knowledge_baseTry in Inspector

Update an existing knowledge base

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated name
`description`	No	Updated description
`knowledgeBaseId`	Yes	The knowledge base ID

update_linkTry in Inspector

Update an existing trigger link

ParametersJSON Schema

Name	Required	Description
`name`	No	Link name
`linkId`	Yes	Link ID
`locationId`	No	Location ID (optional)
`redirectUrl`	No	Redirect URL

update_locationTry in Inspector

Update an existing sub-account/location in GoHighLevel

ParametersJSON Schema

Name	Required	Description
`city`	No	Updated city
`name`	No	Updated name of the sub-account/location
`phone`	No	Updated phone number
`state`	No	Updated state
`address`	No	Updated business address
`country`	No	Updated 2-letter country code
`website`	No	Updated website URL
`timezone`	No	Updated timezone
`companyId`	Yes	Company/Agency ID
`locationId`	Yes	The unique ID of the location to update
`postalCode`	No	Updated postal/ZIP code

update_location_custom_fieldTry in Inspector

Update an existing custom field

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Updated name of the custom field
`position`	No	Updated position/order
`locationId`	Yes	The location ID
`placeholder`	No	Updated placeholder text
`customFieldId`	Yes	The custom field ID to update

update_location_custom_valueTry in Inspector

Update an existing custom value

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Updated name
`value`	Yes	Updated value
`locationId`	Yes	The location ID
`customValueId`	Yes	The custom value ID to update

update_location_tagTry in Inspector

Update an existing location tag

ParametersJSON Schema

Name	Required	Description
`name`	Yes	Updated name for the tag
`tagId`	Yes	The tag ID to update
`locationId`	Yes	The location ID

update_message_statusTry in Inspector

Update the delivery status of a message

ParametersJSON Schema

Name	Required	Description
`error`	No	Error details if status is failed
`status`	Yes	New status for the message
`messageId`	Yes	The unique ID of the message to update
`recipients`	No	Email delivery status for additional recipients
`emailMessageId`	No	Email message ID if updating email status

update_object_recordTry in Inspector

Update an existing record in a custom or standard object

ParametersJSON Schema

Name	Required	Description
`owner`	No	Updated array of user IDs who own this record
`recordId`	Yes	ID of the record to update
`followers`	No	Updated array of user IDs who follow this record
`schemaKey`	Yes	Schema key of the object
`locationId`	No	Location ID (uses default if not provided)
`properties`	No	Updated record properties as key-value pairs

update_object_schemaTry in Inspector

Update object schema properties including labels, description, and searchable fields

ParametersJSON Schema

Name	Required	Description
`key`	Yes	Object key to update
`labels`	No	Updated singular and plural names (optional)
`locationId`	No	Location ID (uses default if not provided)
`description`	No	Updated description
`searchableProperties`	Yes	Array of field keys that should be searchable (e.g., ["custom_objects.pet.name", "custom_objects.pet.breed"])

update_opportunityTry in Inspector

Update an existing opportunity with new details (full update)

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated name/title of the opportunity
`status`	No	Updated status of the opportunity
`assignedTo`	No	Updated assigned user ID
`pipelineId`	No	Updated pipeline ID
`monetaryValue`	No	Updated monetary value in dollars
`opportunityId`	Yes	The unique ID of the opportunity to update
`pipelineStageId`	No	Updated pipeline stage ID

update_opportunity_statusTry in Inspector

Update the status of an opportunity (won, lost, etc.)

ParametersJSON Schema

Name	Required	Description	Default
`status`	Yes	New status for the opportunity
`opportunityId`	Yes	The unique ID of the opportunity

update_saas_rebillingTry in Inspector

Update SaaS rebilling configuration

ParametersJSON Schema

Name	Required	Description	Default
`companyId`	Yes	Company ID
`rebilling`	No	Enable or disable rebilling

update_social_postTry in Inspector

Update an existing social media post

ParametersJSON Schema

Name	Required	Description
`tags`	No	Updated tag IDs
`postId`	Yes	Social media post ID
`status`	No	Updated post status
`summary`	No	Updated post content
`scheduleDate`	No	Updated schedule date

update_task_completionTry in Inspector

Update task completion status

ParametersJSON Schema

Name	Required	Description
`taskId`	Yes	Task ID
`completed`	Yes	Completion status
`contactId`	Yes	Contact ID

update_userTry in Inspector

Update user information. Note: Email update is no longer supported due to security reasons.

ParametersJSON Schema

Name	Required	Description
`role`	No	Updated role. Example: "admin"
`type`	No	Updated user type
`phone`	No	Updated phone number
`scopes`	No	Updated scopes array. If passed empty, all scopes will be disabled
`userId`	Yes	User ID to update (required)
`lastName`	No	Updated last name
`password`	No	New password
`companyId`	No	Company/Agency ID. Required for Agency Level access
`firstName`	No	Updated first name
`locationIds`	No	Updated array of location IDs
`permissions`	No	Updated permissions object
`profilePhoto`	No	Updated profile photo URL
`emailChangeOTP`	No	OTP to change email ID (if email change is needed). Example: "191344"
`scopesAssignedToOnly`	No	Updated assigned-only scopes. If passed empty, all assigned scopes will be disabled

update_voice_ai_agentTry in Inspector

Partially update an existing Voice AI agent configuration

ParametersJSON Schema

Name	Required	Description
`name`	No	Updated name of the Voice AI agent
`model`	No	Updated AI model
`prompt`	No	Updated system prompt/instructions
`agentId`	Yes	Unique identifier of the Voice AI agent to update
`voiceId`	No	Updated voice ID
`language`	No	Updated language code
`maxDuration`	No	Updated maximum call duration in seconds
`temperature`	No	Updated temperature setting (0-2)
`firstMessage`	No	Updated first message
`recordingEnabled`	No	Updated recording setting
`voicemailEnabled`	No	Updated voicemail detection setting

upload_custom_filesTry in Inspector

Upload custom files to forms

ParametersJSON Schema

Name	Required	Description
`fileUrl`	Yes	URL of the file to upload
`contactId`	Yes	Contact ID
`locationId`	No	Location ID

upload_media_fileTry in Inspector

Upload a file to the media library or add a hosted file URL (max 25MB for direct uploads)

ParametersJSON Schema

Name	Required	Description	Default
`file`	No	File data (binary) for direct upload
`name`	No	Custom name for the uploaded file
`altId`	No	Location or Agency ID (uses default location if not provided)
`hosted`	No	Set to true if providing a fileUrl instead of direct file upload
`altType`	No	Context type (location or agency)	location
`fileUrl`	No	URL of hosted file (required if hosted=true)
`parentId`	No	Parent folder ID to upload file into

upload_message_attachmentsTry in Inspector

Upload file attachments for use in messages

ParametersJSON Schema

Name	Required	Description	Default
`attachmentUrls`	Yes	Array of file URLs to upload as attachments
`conversationId`	Yes	The conversation ID to upload attachments for

upload_social_csvTry in Inspector

Upload CSV file for bulk social media posts

ParametersJSON Schema

Name	Required	Description	Default
`file`	Yes	CSV file data (base64 or file path)

upsert_contactTry in Inspector

Create or update contact based on email/phone (smart merge)

ParametersJSON Schema

Name	Required	Description
`tags`	No	Tags to assign to contact
`email`	No	Contact email address
`phone`	No	Contact phone number
`source`	No	Source of the contact
`lastName`	No	Contact last name
`firstName`	No	Contact first name
`assignedTo`	No	User ID to assign contact to

upsert_opportunityTry in Inspector

Create or update an opportunity based on contact and pipeline (smart merge)

ParametersJSON Schema

Name	Required	Description	Default
`name`	No	Name/title of the opportunity
`status`	No	Status of the opportunity	open
`contactId`	Yes	ID of the contact associated with this opportunity
`assignedTo`	No	User ID to assign this opportunity to
`pipelineId`	Yes	ID of the pipeline this opportunity belongs to
`monetaryValue`	No	Monetary value of the opportunity in dollars
`pipelineStageId`	No	Pipeline stage ID

validate_group_slugTry in Inspector

Validate if a calendar group slug is available

ParametersJSON Schema

Name	Required	Description	Default
`slug`	Yes	Slug to validate
`locationId`	No	Location ID

verify_emailTry in Inspector

Verify email address deliverability and get risk assessment. Charges will be deducted from the specified location wallet.

ParametersJSON Schema

Name	Required	Description
`type`	Yes	Verification type: "email" for direct email verification, "contact" for contact ID verification
`verify`	Yes	Email address to verify (if type=email) or contact ID (if type=contact)
`locationId`	Yes	Location ID - charges will be deducted from this location wallet

void_invoiceTry in Inspector

Void an invoice (marks it as cancelled/voided)

ParametersJSON Schema

Name	Required	Description	Default
`altId`	No	Location ID (optional, defaults to configured location)
`invoiceId`	Yes	Invoice ID

FAQ

How do I claim this server?

To claim this server, publish a /.well-known/glama.json file on your server's domain with the following structure:

{ "$schema": "https://glama.ai/mcp/schemas/connector.json", "maintainers": [ { "email": "your-email@example.com" } ] }

The email address must match the email associated with your Glama account. Once verified, the server will appear as claimed by you.

What are the benefits of claiming a server?

Control your server's listing on Glama, including description and metadata
Receive usage reports showing how your server is being used
Get monitoring and health status updates for your server

Try in Browser

Server Details

Available Tools

FAQ

Your Connectors

Resources