Highlevel

Retrieves all available timezones for a GoHighLevel location. Use this action when you need to fetch the list of supported timezones, such as to display timezone options in scheduling interfaces or configure location-specific time settings. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Retrieves all users associated with a specific location in GoHighLevel. Use this action when you need to fetch the list of users belonging to a location, such as to view team members, check user details, or enumerate available users for task assignments. This is a read-only action that retrieves existing users without…

Untrusted display-only summary

Initiates a direct file upload for a GoHighLevel conversation message by requesting a signed GCS upload URL. Use the returned uploadUrl to PUT the file content, then complete the upload via the confirmation endpoint. Required headers (handled automatically): Version: 2021-04-15

Untrusted display-only summary

Lists all active agents for the specified location in Agent Studio. Use this action when you need to retrieve all agents available for a location in GoHighLevel's Agent Studio. The locationId parameter is required to ensure optimal performance. Supports pagination using limit and offset parameters. Optionally filter b…

Untrusted display-only summary

Retrieves all brand voices for a specific location in GoHighLevel. Use this action when you need to fetch all brand voices associated with a location, including their names, descriptions, and sample content that represent the brand's tone. This is a read-only action that retrieves existing brand voices without modific…

Untrusted display-only summary

Retrieves the event notifications configured for a specific GoHighLevel calendar. Use this action to list how and when notifications are sent for calendar events, optionally filtering by active or deleted status and paginating the results. Required headers (handled automatically): Version: 2021-04-15

Untrusted display-only summary

Retrieves a list of all funnels based on the given query parameters. Use this action when you need to fetch all funnels available in a GoHighLevel location, such as to display funnel information, manage funnel content, or retrieve funnel details for marketing campaigns. This is a read-only action that retrieves existi…

Untrusted display-only summary

Retrieves a list of all coupons available in a GoHighLevel location. Use this action when you need to view all promotional offers and special discounts available in a GoHighLevel location. Supports filtering by status (scheduled, active, expired) and searching by coupon name or code. Use pagination parameters to retri…

Untrusted display-only summary

Retrieves a paginated list of product collections for a specific location (sub-account) in GoHighLevel. Use this action to browse or filter product collections by name or by specific collection ids. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Retrieves the list of tags defined in a GoHighLevel sub-account (location). Use this action to fetch all tags available for a given location, including each tag's id, name, and location identifier. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Creates a new custom field within a GoHighLevel sub-account (location). Use this action to define a custom field for contacts or opportunities, specifying its name, data type, and other display options. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Deletes a custom field from a GoHighLevel location (sub-account). Use this action to permanently remove a custom field identified by its id within the specified locationId. This operation is destructive and cannot be undone. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Updates an existing custom field in a GoHighLevel sub-account (location). Use this action to modify a custom field's name, placeholder, position, accepted formats, and other attributes. The locationId and id together identify the custom field to update. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Updates an existing sub-account/location in GoHighLevel. Use this action to modify a location's business details, settings, social links, and integration credentials. The locationId identifies the location to update. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Removes a contact from all campaigns they are enrolled in. Use this action when you need to unenroll a contact from all marketing campaigns in GoHighLevel. This action is irreversible — the contact will be removed from all campaigns and would need to be re-enrolled manually if needed. Required headers (handled automat…

Untrusted display-only summary

Removes one or more tags from a contact in a GoHighLevel sub-account. Use this action to detach existing tags from a contact identified by its contactId. The tags to remove are provided in the request body. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Removes one or more followers from a contact in a GoHighLevel sub-account. Provide the contactId and a list of follower user IDs to remove. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Removes one or more followers from an existing opportunity in a GoHighLevel sub-account. Provide the opportunity id and the list of follower user IDs to remove, or set isRemoveAllFollowers to true to remove all followers. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Searches for contacts in a GoHighLevel sub-account using advanced filters, sorting, and pagination. Use this action to find contacts matching specific criteria within a location. The locationId is required and identifies the sub-account to search. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Searches for AI agents based on various criteria including name, status, and configuration. Use this action when you need to find conversation AI agents in GoHighLevel with support for advanced filtering and full-text search capabilities. Supports full-text search across agent names and descriptions. The target locati…

Untrusted display-only summary

Returns a list of all conversations matching the search criteria along with the sort and filter options selected. Use this action when you need to search and retrieve conversations from GoHighLevel with various filtering options such as status, assigned user, contact, message type, direction, and more. Required header…

Untrusted display-only summary

Searches for duplicate contacts in a GoHighLevel location. Use this action when you need to find contacts that may already exist in the system before creating a new contact. If `Allow Duplicate Contact` is disabled under Settings, the global unique identifier will be used for searching the contact. If the setting is e…

Untrusted display-only summary

Searches for trigger links within a GoHighLevel location. Use this action when you need to find or retrieve a list of trigger links based on search criteria. The search supports filtering by a query string and pagination via skip/limit parameters. Results are scoped to the specified location ID. Required headers (hand…

Untrusted display-only summary

Searches for sub-accounts (locations) within a GoHighLevel agency. Use this action to look up locations belonging to a company, optionally filtering by email and paginating through the results using skip and limit. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Searches records of a custom object in a GoHighLevel sub-account. Use this action to find records of a given object schema by querying its searchable properties. The schemaKey identifies the object, locationId identifies the sub-account, and query drives the search. Required headers (handled automatically): Version: 2…

Untrusted display-only summary

Searches for opportunities within a GoHighLevel sub-account. Use this action to find and filter opportunities by pipeline, stage, contact, assigned user, status, date, and more. The location_id is required and identifies the sub-account to search. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Performs an advanced search for opportunities within a GoHighLevel sub-account. Use this action to query opportunities with pagination and optionally include related entities such as notes, tasks, calendar events, and unread conversations for each result. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Searches users in a HighLevel company and location. Use this action to harvest user IDs for assignment, follower, schedule, and calendar-resource workflows. Required headers (handled automatically): Version: 2021-07-28

Untrusted display-only summary

Sends a message to a contact in a GoHighLevel sub-account across a channel (SMS, RCS, Email, WhatsApp, Instagram, or Facebook). Use this action to deliver outbound messages, schedule them, or reply within an existing conversation thread. The message type and contactId are required. Required headers (handled automatica…

Untrusted display-only summary

Sets a brand voice as the default for a location. Use this action when you need to designate a specific brand voice as the default for a location, which automatically unsets the previous default brand voice. This action is idempotent - setting the same brand voice as default multiple times will return a successful res…

Untrusted display-only summary