---
title: Highlevel API Integration on Truto
slug: highlevel
category: CRM
canonical: "https://truto.one/integrations/detail/highlevel/"
---

# Highlevel API Integration on Truto



**Category:** CRM  
**Status:** Generally available

## Unified APIs

### Unified Marketing Automation API

- **Automations** — The automation represents workflow or custom event in the remote system.
- **Contacts** — The contact represent a contact in the remote system.
- **Tags** — The tags on a contact in the remote system.
- **Users** — The user represent a user in the remote system.
- **Workspaces** — The workspace represent a workspace in the remote system.

### Unified CRM API

- **Accounts** — The accounts represent a company in a CRM.
- **Contacts** — The contacts represent an existing point of contact at a company in a CRM.
- **Engagement Types** — The engagement types represent an interaction activity in a CRM.
- **Engagements** — The engagements represent an interaction noted in a CRM.
- **Fields** — The fields of entities in a CRM.
- **Notes** — The notes represent a note on another object in a CRM.
- **Opportunities** — The opportunities represent an opportunity in a CRM.
- **Pipelines** — 
- **Stages** — The stages represent a stage of an opportunity in a CRM.
- **Tasks** — The tasks represent a task in a CRM.
- **Users** — The users represent a user in a CRM.
- **Workspaces** — The workspace represent a workspace in the remote system.

### Unified User Directory API

- **Roles** — The Role object represents a role of a User.
- **Users** — The User object represents a User.
- **Workspaces** — Workspaces represent concepts like teams, workspaces, projects in apps that support them

## MCP-ready AI tools

Truto exposes 297 tools for Highlevel that AI agents can call directly.

- **list_all_highlevel_contacts** — Get contacts in Highlevel. Returns contacts array with fields id, locationId, email, timezone, country, source, dateAdded, customFields, tags, businessId, attributions, and followers. Note: endpoint is deprecated.
- **get_single_highlevel_contact_by_id** — Get contact details by id in Highlevel. Returns id, name, firstName, lastName, email, phone, companyName, address, tags, dateOfBirth, dateAdded, dateUpdated, dnd status, source, assignedTo, customFields, attributionSource, lastAttributionSource, and visitorId.
- **create_a_highlevel_contact** — Upsert a contact in Highlevel. Returns contact details including id, name, email, phone, address, tags, customFields, and assignedTo.
- **update_a_highlevel_contact_by_id** — Update contact by id in Highlevel. Returns fields including id, name, email, phone, address, timezone, dnd settings, tags, customFields, assignedTo, and date metadata.
- **delete_a_highlevel_contact_by_id** — Delete contact by id in Highlevel. Returns 'succeded' boolean indicating if the deletion was successful.
- **highlevel_contacts_add_followers** — Add followers to a contact in Highlevel using contact id. Returns followers and followersAdded arrays showing all followers and newly added followers respectively.
- **highlevel_contacts_remove_followers** — Remove followers from a specific contact in Highlevel using contact id. Returns the followers list and followersRemoved list indicating which followers were removed.
- **list_all_highlevel_locations** — Get details of a Sub-Account (Formerly Location) associated with the access token. Returns id, companyId, name, domain, address, city, state, logoUrl, country, postalCode, website, timezone, firstName, lastName, email, phone, business info, social links, settings, and reseller info.
- **create_a_highlevel_location** — Create a new sub-account in Highlevel with required parameters name, companyId, prospectInfo.firstName, prospectInfo.lastName, prospectInfo.email, twilio.sid, twilio.authToken, mailgun.apiKey, and mailgun.domain. Returns the created location details.
- **update_a_highlevel_location_by_id** — Update a sub-account (formerly location) by id in Highlevel. Requires location id and companyId. Returns snapshot object with updated snapshot id and override status.
- **delete_a_highlevel_location_by_id** — Delete a Sub-Account (Formerly Location) by id in Highlevel. Requires id and deleteTwilioAccount parameter to indicate whether to delete the Twilio Account.
- **list_all_highlevel_custom_fields** — Get custom field values for a specific location in Highlevel. Returns id, name, fieldKey, value, and locationId for each custom field. 
- **get_single_highlevel_custom_field_by_id** — Get a custom field value by id in Highlevel. Returns id, name, fieldKey, value, and locationId of the custom value.
- **create_a_highlevel_custom_field** — Create a custom field in Highlevel for the location specified by location_id. Returns the created custom field including its name, dataType, and model.
- **update_a_highlevel_custom_field_by_id** — Update a custom field by id and location_id in Highlevel. Returns the updated custom field including name, placeholder, acceptedFormat, isMultipleFile, maxNumberOfFiles, textBoxListOptions, and model.
- **delete_a_highlevel_custom_field_by_id** — Delete a custom field by id and location_id in Highlevel.
- **list_all_highlevel_pipelines** — Get pipelines for location in Highlevel. Returns id, name, stages, showInFunnel, showInPieChart, and locationId fields for each pipeline.
- **list_all_highlevel_search_locations** — Search sub-accounts (locations) in Highlevel. Returns location details including id, name, phone, email, address, city, state, country, postalCode, website, timezone, settings, and social links.
- **list_all_highlevel_tags** — Get tags for a specific location in Highlevel. Returns tag name, locationId, and id fields in the response.
- **get_single_highlevel_tag_by_id** — Get tag by id in Highlevel. Returns tag fields name, locationId, and id.
- **create_a_highlevel_tag** — Create tag with name in Highlevel for location_id. Returns tag fields name, locationId, and id.
- **update_a_highlevel_tag_by_id** — Update tag name for a specific tag in Highlevel. Requires location_id and id. Returns the updated tag with its name.
- **delete_a_highlevel_tag_by_id** — Delete tag by location_id and id in Highlevel.
- **list_all_highlevel_search_contacts** — Search contacts in Highlevel using advanced filters. Returns contacts with fields including id, address, source, locationId, dnd, state, businessName, customFields, tags, dateAdded, additionalEmails, phone, companyName, additionalPhones, dateUpdated, and firstNameLowerCase.Also returns the total count of matching contacts.
- **highlevel_search_contacts_duplicate** — Get duplicate contact in Highlevel. Returns contacts matching email or phone based on duplicate contact settings. Response includes contact details for duplicates found.
- **list_all_highlevel_campaigns** — Get campaigns in Highlevel. Returns campaigns with fields id, name, status, and locationId.
- **highlevel_campaigns_add_contact** — Add a contact to a campaign in Highlevel using contact_id and campaign_id.  If the contact is successfully added, it returns a success status of true.
- **highlevel_campaigns_remove_contact** — Remove a contact from a campaign in Highlevel using contact_id and id. If the contact is successfully removed, it returns a success status of true.
- **highlevel_campaigns_remove_contact_from_all** — Remove contact from every campaign in Highlevel using contact_id. If the contact is successfully removed, it returns a success status of true.
- **list_all_highlevel_workflows** — Get workflows for the location in Highlevel. Returns id, name, status, version, createdAt, updatedAt, and locationId for each workflow.
- **highlevel_workflows_add_contact** — Add a contact to a workflow in Highlevel using contact_id and workflow_id.  If the contact is successfully added, it returns a success status of true.
- **highlevel_workflows_delete_contact** — Delete a workflow association for a contact in Highlevel using contact_id and workflow_id. If the contact is successfully removed, it returns a success status of true.
- **list_all_highlevel_users** — Get users for the location in Highlevel. Returns users array with id, name, firstName, lastName, email, phone, permissions (features enabled), scopes, roles (type, role, locationIds), deleted status, and lcPhone (locationId).
- **get_single_highlevel_user_by_id** — Get user details by id in Highlevel. Returns id, name, firstName, lastName, email, phone, extension, permissions object with feature flags, scopes string, roles object with type, role, locationIds, restrictSubAccount, and lcPhone object with locationId.
- **update_a_highlevel_user_by_id** — Update user by id in Highlevel. Requires id. Returns updated user fields including id, name, firstName, lastName, email, phone, permissions (feature access booleans), scopes (enabled scopes), roles (type, role, locationIds, restrictSubAccount), and lcPhone (inbound phone numbers).
- **delete_a_highlevel_user_by_id** — Delete user by id in Highlevel. If the user is successfully deleted, it returns a success status of true. Deletion takes effect in a few minutes.
- **create_a_highlevel_user** — Create a user in Highlevel with required parameters companyId, firstName, lastName, email, password, type, role. Returns user id, name, firstName, lastName, email, phone, permissions, scopes, roles, and lcPhone details.
- **list_all_highlevel_templates** — Get all email or SMS templates in Highlevel. Returns template id, name, type, body, attachments, dateAdded, locationId, and urlAttachments.
- **list_all_highlevel_businesses** — Get businesses in Highlevel. Returns id, name, phone, email, website, address, city, description, state, postalCode, country, updatedBy, locationId, createdBy, createdAt, and updatedAt fields for each business.
- **get_single_highlevel_business_by_id** — Get business details by id in Highlevel. Returns id, name, phone, email, website, address, city, description, state, postalCode, country, updatedBy, locationId, createdBy, createdAt, and updatedAt fields.
- **create_a_highlevel_business** — Create a new business in Highlevel. Returns the created business object including its id and key details.
- **update_a_highlevel_business_by_id** — Update business by id in Highlevel. Returns success status and updated business details including id, name, phone, email, website, address, city, description, state, postalCode, country, updatedBy, locationId, createdBy, createdAt, and updatedAt.
- **delete_a_highlevel_business_by_id** — Delete a business by id in Highlevel. Returns a success boolean indicating if the deletion was successful.
- **highlevel_businesses_add_contacts** — Add or remove contacts from a business in Highlevel using ids, and businessId. Returns success status and the list of contact ids affected.
- **list_all_highlevel_company** — Get company details by the company id associated with the current token in Highlevel. Returns fields including id, name, email, phone, website, address, timezone, plan, status, and billingInfo with subscription and trial details.
- **list_all_highlevel_opportunities** — Search opportunities by location in Highlevel. Returns id, name, monetaryValue, pipelineId, pipelineStageId, assignedTo, status, contact details, notes, tasks, calendarEvents, customFields, and followers.
- **get_single_highlevel_opportunity_by_id** — Get opportunity by id in Highlevel. Returns id, name, monetaryValue, pipelineId, pipelineStageId, assignedTo, status, lastStatusChangeAt, lastStageChangeAt, lastActionDate, createdAt, updatedAt, contactId, locationId, contact details, notes, tasks, calendarEvents, customFields, and followers.
- **create_a_highlevel_opportunity** — Create an opportunity in Highlevel. Returns opportunity fields including id, name, monetaryValue, pipelineId, pipelineStageId, assignedTo, status, timestamps, contactId, locationId, contact details, notes, tasks, calendarEvents, customFields, and followers.
- **update_a_highlevel_opportunity_by_id** — Update opportunity by id in Highlevel. Returns updated opportunity fields including id, name, monetaryValue, pipelineId, pipelineStageId, assignedTo, status, timestamps, contact info, notes, tasks, calendarEvents, customFields, and followers.
- **delete_a_highlevel_opportunity_by_id** — Delete opportunity by id in Highlevel. If the opportunity is successfully deleted, it returns a success status of true.
- **highlevel_opportunities_status** — Update the opportunity status by opportunity id in Highlevel. Returns a 'succeded' boolean indicating if the update was successful. The status must be one of open, won, lost, abandoned, or all.
- **highlevel_opportunities_add_followers** — Add followers to an opportunity in Highlevel by specifying the opportunity id and an array of follower ids. Returns the updated followers and the followers added.
- **highlevel_opportunities_remove_followers** — Remove followers from an opportunity in Highlevel by providing the opportunity id and a list of follower ids. Returns the lists of current followers and followers removed.
- **list_all_highlevel_custom_values** — Get custom values for a specific location in Highlevel. Returns id, name, fieldKey, value, and locationId for each custom value.
- **get_single_highlevel_custom_value_by_id** — Get a custom value by id in Highlevel. Returns id, name, fieldKey, value, and locationId of the custom value.
- **create_a_highlevel_custom_value** — Create a custom value for a location in Highlevel using location_id. Returns id, name, fieldKey, value, and locationId of the created custom value.
- **update_a_highlevel_custom_value_by_id** — Update Custom Value by id in Highlevel. Returns id, name, fieldKey, value, and locationId of the updated custom value.
- **delete_a_highlevel_custom_value_by_id** — Delete a custom value by id in Highlevel. Returns 'succeded' boolean indicating success.
- **list_all_highlevel_notes** — Get all notes for a specific contact in Highlevel. Requires contact_id. Returns note id, body, userId, dateAdded, and contactId fields in the response.
- **get_single_highlevel_note_by_id** — Get a note by id for a contact using contact_id in Highlevel. Returns note fields id, body, userId, dateAdded, and contactId.
- **create_a_highlevel_note** — Create a note for a contact in Highlevel using contact_id and body. Returns note id, body, userId, dateAdded, and contactId.
- **update_a_highlevel_note_by_id** — Update a note for a specific contact in Highlevel using contact_id and id. Returns the updated note with id, body, userId, dateAdded, and contactId fields.
- **delete_a_highlevel_note_by_id** — Delete a note by contact_id and id in Highlevel. If the note is successfully deleted, it returns a success status of true.
- **list_all_highlevel_tasks** — Get all tasks for contact_id in Highlevel. Returns id, title, body, assignedTo, dueDate, completed, and contactId fields for each task.
- **get_single_highlevel_task_by_id** — Get task details by contact_id and id in Highlevel. Returns task fields id, title, body, assignedTo, dueDate, completed, and contactId.
- **create_a_highlevel_task** — Create a task for a specific contact in Highlevel using contact_id. Returns the created task's id, title, body, assignedTo, dueDate, completed status, and contactId.
- **update_a_highlevel_task_by_id** — Update task with id for contact_id in Highlevel. Returns task fields id, title, body, assignedTo, dueDate, completed, and contactId.
- **delete_a_highlevel_task_by_id** — Delete a task by contact_id and id in Highlevel. Returns succeded boolean indicating if the deletion was successful.
- **highlevel_tasks_completed** — Update task completion status for task with task_id and contact_id in Highlevel. Returns task fields id, title, body, assignedTo, dueDate, completed, and contactId.
- **list_all_highlevel_conversations** — Get a list of conversations in Highlevel. Returns conversation id, contactId, locationId, lastMessageBody, lastMessageType, type, unreadCount, fullName, contactName, email, phone, and total number of results.
- **get_single_highlevel_conversation_by_id** — Get conversation details by id in Highlevel. Returns contactId (contact identifier), locationId (business location), deleted (trash status), inbox (inbox status), type (channel type), unreadCount (unread messages), assignedTo (responsible team member), id (conversation id), and starred (importance flag).
- **delete_a_highlevel_conversation_by_id** — Delete conversation details by id in Highlevel. Returns success boolean indicating if the deletion was successful.
- **update_a_highlevel_conversation_by_id** — Update conversation details by id in Highlevel. Returns conversation fields including id, locationId, contactId, assignedTo, userId, lastMessageBody, lastMessageDate, lastMessageType, unreadCount, inbox, starred, and deleted.
- **create_a_highlevel_conversation** — Create a new conversation in Highlevel. Returns conversation id, dateUpdated, dateAdded, deleted flag, contactId, locationId, lastMessageDate, and assignedTo fields.
- **list_all_highlevel_appointments** — Get appointments for contact using contact_id in Highlevel. Returns id, calendarId, status, title, appointmentStatus, assignedUserId, notes, startTime, endTime, address, locationId, contactId, groupId, users, dateAdded, dateUpdated, and assignedResources fields.
- **list_all_highlevel_search_tasks** — Search tasks in High Level. Returns a tasks array with task details matching contactId, completed status, assignedTo, query, and businessId filters.
- **list_all_highlevel_calendars** — Get all calendars in Highlevel. Returns calendar details including id, name, eventType, calendarType, slotDuration, openHours, and teamMembers.
- **get_single_highlevel_calendar_by_id** — Get calendar by id in Highlevel. Returns calendar fields including isActive, locationId, groupId, teamMembers, eventType, name, description, calendarType.
- **create_a_highlevel_calendar** — Create calendar in Highlevel. Returns calendar details including isActive, teamMembers, eventType, name, description, calendarType, widgetType, slotDuration, openHours, recurring settings, and calendar id.
- **delete_a_highlevel_calendar_by_id** — Delete calendar by id in Highlevel. If the calendar is successfully deleted, it returns a success status of true.
- **update_a_highlevel_calendar_by_id** — Update the calendar by id in Highlevel. Returns calendar fields including isActive, notifications, groupId, teamMembers, eventType, name, description, slug, widgetSlug, and calendarType.
- **highlevel_calendars_block_slots** — Create a block slot with startTime, endTime, and title in Highlevel. Returns id, locationId, title, startTime, endTime, calendarId, and assignedUserId in the response.
- **list_all_highlevel_calendar_free_slots** — Get free slots for a calendar using calendar_id, startDate, and endDate in Highlevel. Returns a slots array representing available free time slots.
- **list_all_highlevel_calendar_groups** — Get all calendar groups in Highlevel. Returns groups with fields locationId, name, description, slug, isActive, and id.
- **create_a_highlevel_calendar_group** — Create a calendar group with name, description, slug, and isActive in Highlevel. Returns group fields locationId, name, description, slug, isActive, and id.
- **highlevel_calendar_groups_validate_slug** — Validate if a group slug is available in Highlevel. Requires a slug. Returns 'available' boolean indicating slug availability.
- **delete_a_highlevel_calendar_group_by_id** — Delete a calendar group by id in Highlevel. Returns success boolean indicating if the deletion was successful.
- **update_a_highlevel_calendar_group_by_id** — Update the group by id in Highlevel. Returns group object with locationId, name, description, slug, isActive, and id fields.
- **highlevel_calendar_groups_disable** — Disable or enable a calendar group by setting isActive in Highlevel. Requires group_id and isActive parameters. Returns a success status indicating the operation result.
- **list_all_highlevel_calendar_events** — Get calendar events in Highlevel. Either calendarId, userId, or groupId is required and should specify startTime and endTime. Returns event id, title, calendarId, locationId, contactId, groupId, appointmentStatus, assignedUserId, users, notes, startTime, endTime, dateAdded, dateUpdated, assignedResources, createdBy, and masterEventId.
- **update_a_highlevel_calendar_event_by_id** — Update appointment by id in Highlevel. Returns calendarId, locationId, contactId, startTime, endTime, title, meetingLocationType, appointmentStatus, assignedUserId, address, isRecurring, rrule, and id.
- **get_single_highlevel_calendar_event_by_id** — Get appointment by id in Highlevel. Returns event fields including id, title, calendarId, locationId, contactId, groupId, appointmentStatus, assignedUserId, users, notes, isRecurring, rrule, startTime, endTime, dateAdded, dateUpdated, assignedResources, createdBy, and masterEventId.
- **create_a_highlevel_calendar_event** — Create an appointment in Highlevel with the required parameters calendarId, contactId, startTime, and endTime. Returns calendarId, locationId, contactId, startTime, endTime, title, meetingLocationType, appointmentStatus, assignedUserId, address, isRecurring, rrule, and id.
- **delete_a_highlevel_calendar_event_by_id** — Delete event by id in Highlevel. If the event is successfully deleted, it returns a success status of true.
- **list_all_highlevel_calendar_blocked_slots** — Get blocked slots in Highlevel calendars with the required parameters startTime and endTime. Returns event details including id, title, calendarId, locationId, contactId, groupId, appointmentStatus, assignedUserId, users, notes.
- **update_a_highlevel_calendar_blocked_slot_by_id** — Update block slot by id in Highlevel. Returns id, locationId, title, startTime, endTime, calendarId, and assignedUserId in the response.
- **list_all_highlevel_calendar_resources** — List calendar resources by resource_type in Highlevel. Returns locationId, name, resourceType, isActive, description, quantity, outOfService, capacity, and calendarIds for each resource.
- **get_single_highlevel_calendar_resource_by_id** — Get calendar resource by resource_type and id in Highlevel. Returns locationId, name, resourceType, isActive, description, quantity, outOfService, capacity, and calendarIds fields.
- **create_a_highlevel_calendar_resource** — Create a calendar resource by resource_type in Highlevel. Requires name, description, quantity, outOfService, capacity, and calendarIds. Returns locationId, name, resourceType, isActive, description, quantity, outOfService, capacity, and calendarIds.
- **update_a_highlevel_calendar_resource_by_id** — Update calendar resource by id and resource_type in Highlevel. Returns locationId, name, resourceType, isActive, description, quantity, outOfService, and capacity fields in the response.
- **delete_a_highlevel_calendar_resource_by_id** — Delete calendar resource by id and resource_type in Highlevel. Returns success indicating if the resource was deleted.
- **list_all_highlevel_calendar_notifications** — Get calendar notifications for the calendar in Highlevel. Returns _id (notification ID), altType, calendarId, receiverType, additionalEmailIds, channel, notificationType, isActive, templateId, body, subject, afterTime, beforeTime, selectedUsers, and deleted fields.
- **get_single_highlevel_calendar_notification_by_id** — Get notification details by using the calendar_id and id in Highlevel. Returns fields including _id (Notification ID), altType, calendarId, receiverType, additionalEmailIds, channel, notificationType, isActive, templateId, body, subject, afterTime, beforeTime, selectedUsers, and deleted.
- **create_a_highlevel_calendar_notification** — Create calendar notifications for calendar with id. Returns array of notifications with fields _id (notification ID), altType (calendar), calendarId, receiverType, additionalEmailIds, channel, notificationType, isActive, templateId, body, subject, afterTime, beforeTime, selectedUsers, and deleted.
- **update_a_highlevel_calendar_notification_by_id** — Update Event notification by id in Highlevel. Requires calendar_id and id. Returns message indicating the result of the update operation.
- **delete_a_highlevel_calendar_notification_by_id** — Delete notification by calendar_id and id in Highlevel. Returns a message indicating the result of the delete operation.
- **list_all_highlevel_business_contacts** — Get contacts by business_id in Highlevel. Returns contacts with id, locationId, email, timezone, country, source, dateAdded, customFields, tags, businessId, attributions, and followers. Requires business_id and locationId.
- **create_a_highlevel_contact_tag** — Add tags to a contact in Highlevel using contact_id. Returns the tags array added to the contact.
- **delete_a_highlevel_contact_tag_by_id** — Remove tags from a specific contact in Highlevel using contact_id. Returns the list of tags removed in the response.
- **update_a_highlevel_contact_tag_by_id** — Update tags for multiple contacts by specifying type, contacts, tags, and removeAllTags in Highlevel. Returns success status, error count, and detailed responses per contact, including contactId, message, type, oldTags, tagsAdded, and tagsRemoved.
- **list_all_highlevel_objects** — Get all objects for a location in Highlevel. Returns an array of objects with id, standard (boolean), key, labels (singular and plural), description, locationId, primaryDisplayProperty, dateAdded, dateUpdated, and type fields.
- **get_single_highlevel_object_by_id** — Get the schema of a custom or standard object by id in Highlevel. Returns object id, key, labels, description, locationId, primaryDisplayProperty, dateAdded, dateUpdated, type, cache status, and fields with details like name, description, dataType, and options.
- **create_a_highlevel_object** — Create a custom object schema in Highlevel with labels, key, description, and primaryDisplayPropertyDetails. Returns id, standard flag, key, labels, description, locationId, primaryDisplayProperty, dateAdded, dateUpdated, and type.
- **update_a_highlevel_object_by_id** — Update custom or standard object schema by id in Highlevel. Returns id, standard flag, key, labels, description, locationId, primaryDisplayProperty, dateAdded, dateUpdated, and type.
- **get_single_highlevel_object_record_by_id** — Get a record by id and schema_key in Highlevel. Returns record id, owner (user ids), followers (user ids), properties (record details), dateAdded, and dateUpdated.
- **create_a_highlevel_object_record** — Create a custom object record in Highlevel using schemaKey. Returns id, owner, followers, properties, dateAdded, and dateUpdated of the created record.
- **update_a_highlevel_object_record_by_id** — Update a Custom Object Record by id and schema_key in Highlevel. Returns updated record with id, owner, followers, properties, dateAdded, and dateUpdated fields.
- **delete_a_highlevel_object_record_by_id** — Delete a record by id and schema_key in Highlevel. Returns the id of the deleted record and a success boolean indicating the operation result.
- **list_all_highlevel_object_records** — Search object records by schema_key in Highlevel. Returns records with id, owner, followers, properties, createdAt, updatedAt, locationId, objectId, objectKey, createdBy, lastUpdatedBy, and searchAfter fields.
- **get_single_highlevel_conversation_email_by_id** — Get email by id in Highlevel. Returns id, threadId, locationId, contactId, conversationId, dateAdded, subject, body, direction, status, contentType, attachments, provider, from, to, cc, bcc, replyToMessageId, source, and conversationProviderId.
- **create_a_highlevel_conversation_provider_chat** — Send typing status for a live chat conversation in Highlevel. Requires locationId, isTyping, visitorId, and conversationId. Returns success boolean indicating if the typing indicator was shown.
- **list_all_highlevel_conversation_messages** — Get messages by conversation id in Highlevel. Requires conversation_id. Returns messages array with id, messageType, contactId, conversationId, dateAdded, body, direction, status, contentType, attachments, source, userId, and conversationProviderId fields.
- **get_single_highlevel_conversation_message_by_id** — Get message by id in Highlevel. Returns id, type, messageType, locationId, contactId, conversationId, dateAdded, body, direction, status, contentType, attachments, meta (callDuration, callStatus, email messageIds), source, userId, and conversationProviderId.
- **create_a_highlevel_conversation_message** — Send a new message with type and contactId in Highlevel. Returns conversationId, messageId, emailMessageId (for Email type), messageIds (for GMB channel), and a status message.
- **delete_a_highlevel_conversation_message_by_id** — Cancel a scheduled message by id in Highlevel. Returns the status and message indicating whether the cancellation was successful or not.
- **update_a_highlevel_conversation_message_by_id** — Update message status for id in Highlevel. Returns conversationId, emailMessageId, messageId or messageIds, and a response message indicating the update result.
- **highlevel_conversation_messages_inbound_message** — Create an inbound message in Highlevel with required conversationId and conversationProviderId. Returns success status, conversationId, messageId, message content, contactId, dateAdded, and emailMessageId.
- **highlevel_conversation_messages_outbound_message** — Create an outbound call message in Highlevel with required fields conversationId and conversationProviderId. Returns success status, conversationId, messageId, message, contactId, dateAdded, and emailMessageId.
- **highlevel_conversation_messages_file_attachments** — Upload file attachments to a conversation message in Highlevel. Requires conversationId. Returns uploadedFiles object with URLs of the uploaded files. Allowed file types include JPG, PNG, MP4, ZIP, PDF, DOC, TXT, MP3, and WAV.
- **list_all_highlevel_conversation_message_recordings** — Get the recording for a message by passing message_id in Highlevel. The response returns the audio recording as an attachment with Content-Disposition and Content-Type headers.
- **list_all_highlevel_conversation_message_transcription** — Get the recording transcription in Highlevel. Returns mediaChannel, sentenceIndex, startTime, endTime, transcript, and confidence fields.
- **highlevel_conversation_message_transcription_download** — Download the transcription of a message in Highlevel. The response returns the transcription text file as an attachment with filename 'transcription.txt'.
- **list_all_highlevel_search_users** — Search users by company_id in Highlevel. Returns users with fields id, name, firstName, lastName, email, phone, permissions, scopes, roles, deleted, and lcPhone. Supports filtering by ids, locationId, query, role, type, and sorting.
- **list_all_highlevel_associations** — Get all associations for a location in Highlevel. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType fields.
- **get_single_highlevel_association_by_id** — Get association by id in Highlevel. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType which can be USER_DEFINED or SYSTEM_DEFINED.
- **update_a_highlevel_association_by_id** — Update association labels by id in Highlevel. Requires id and body with firstObjectLabel and secondObjectLabel. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType.
- **delete_a_highlevel_association_by_id** — Delete association by id in Highlevel. Returns deleted status, id, and message confirming deletion. Deleting an association also removes all its relations.
- **create_a_highlevel_association** — Create an association key, firstObjectLabel, firstObjectKey, secondObjectLabel, and secondObjectKey in Highlevel. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType.
- **highlevel_associations_association_by_key** — Get association by key_name in Highlevel. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType fields.
- **highlevel_associations_association_by_object_key** — Get the association by object_key in Highlevel. Requires objectKey path parameter. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType fields.
- **list_all_highlevel_association_record_relations** — Get all relations by record_id in Highlevel. Requires recordId, limit, locationId, and skip. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType fields.
- **delete_a_highlevel_association_record_relation_by_id** — Delete relation by id in Highlevel. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType in the response.
- **create_a_highlevel_association_record_relation** — Create relation between associated entities in Highlevel using associationId, firstRecordId, and secondRecordId. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType.
- **highlevel_courses_import** — Import courses with userId, and products including title, description, imageUrl, categories, and instructorDetails in Highlevel. Returns 201 status on success.
- **list_all_highlevel_scheduled_email_campaigns** — Get scheduled email campaigns in High Level. It returns fields including id, name, status, createdAt, updatedAt, templateId, downloadUrl, and campaignType.
- **list_all_highlevel_email_templates** — Get email templates in Highlevel. Returns fields: id, name, updatedBy, isPlainText, lastUpdated, dateAdded, previewUrl, version, and templateType.
- **create_a_highlevel_email_template** — Create a new email template in Highlevel with required parameters type, and importProvider. Returns redirect as template id and traceId for tracking.
- **update_a_highlevel_email_template_by_id** — Update an email template with templateId, updatedBy, and dnd content in Highlevel. Returns ok status, traceId, previewUrl, and templateDownloadUrl.
- **delete_a_highlevel_email_template_by_id** — Delete an email template by location_id and id in Highlevel. Returns 'ok' indicating success and 'traceId' for request tracking.
- **list_all_highlevel_forms** — Get forms in Highlevel. Returns form id, name, locationId, and total number of forms.
- **highlevel_forms_upload_custom_files** — Upload files to custom fields for a contact in Highlevel using contactId. Returns the updated contact object. File size limit is 50 MB and supports specific file types including PDF, DOCX, JPG, PNG, MP4, ZIP, and others.
- **list_all_highlevel_form_submissions** — Get form submissions in Highlevel. Returns id, contactId, createdAt, formId, name, email, and others fields in the response.
- **list_all_highlevel_invoice_templates** — List invoice templates in Highlevel. Returns template id, name, business details, currency, discount, items, invoice number prefix, total amount, createdAt, and updatedAt fields.
- **get_single_highlevel_invoice_template_by_id** — Get an invoice template by id in Highlevel. Returns template id, altId, altType, name, businessDetails (name, address, phoneNo, website, logoUrl, customValues), currency, discount (type, value, validOnProductIds), items (taxes, _id, productId, priceId, currency, name, qty, amount), invoiceNumberPrefix, total, createdAt, and updatedAt.
- **create_a_highlevel_invoice_template** — Create an invoice template in Highlevel. Returns template _id, altId, altType, name, businessDetails, currency, discount, items, invoiceNumberPrefix, total, createdAt, and updatedAt.
- **update_a_highlevel_invoice_template_by_id** — Update an invoice template by id in Highlevel. Returns updated template with fields _id, altId, altType, name, businessDetails (name, address, phoneNo, website, logoUrl, customValues), currency, discount (type, value, validOnProductIds), items (taxes, _id, productId, priceId, currency, name, qty, amount), invoiceNumberPrefix, total, createdAt, and updatedAt.
- **delete_a_highlevel_invoice_template_by_id** — Delete invoice template by id in Highlevel. Returns success boolean indicating deletion status.
- **highlevel_invoice_templates_late_fees_configuration** — Update template late fees configuration by template id in Highlevel. Returns template id, altId, altType, name, businessDetails including name, address, phoneNo, website, logoUrl, customValues, currency, discount details, items with product info, invoiceNumberPrefix, total, createdAt, and updatedAt.
- **highlevel_invoice_templates_payment_methods_configuration** — Update template late fees configuration by template id in Highlevel. Requires templateId. Returns template details including _id, altId, altType, name, businessDetails.
- **list_all_highlevel_invoice_schedules** — Get list of invoice schedules in Highlevel. Returns schedule id, status, liveMode, altId, altType, name, schedule details, invoices with business and contact details, currency, discount, items, total, title, termsNotes, createdAt, and updatedAt.
- **get_single_highlevel_invoice_schedule_by_id** — Get an invoice schedule by id in Highlevel. Returns schedule id, status, liveMode, altId, altType, name, schedule details, list of invoices with invoice id, status, amountPaid, businessDetails, invoiceNumber, currency, contactDetails, issueDate, dueDate.
- **create_a_highlevel_invoice_schedule** — Create an invoice schedule in Highlevel. Returns schedule id, status, liveMode, altId, altType, name, schedule details, invoices with id, status, amountPaid, businessDetails, invoiceNumber, currency, contactDetails, issueDate, dueDate, discount, invoiceItems, total, title, amountDue, createdAt, updatedAt, automaticTaxesEnabled, automaticTaxesCalculated, paymentSchedule, businessDetails, currency, contactDetails, discount, items, total, title, termsNotes, compiledTermsNotes, createdAt, and updatedAt.
- **update_a_highlevel_invoice_schedule_by_id** — Update an invoice schedule by id in Highlevel. Returns updated schedule with fields _id (schedule id), status, liveMode, altId, altType, name, schedule details, invoices list with invoice details, businessDetails, currency, contactDetails, discount, items, total, title, termsNotes, compiledTermsNotes, createdAt, and updatedAt.
- **delete_a_highlevel_invoice_schedule_by_id** — Delete schedule by id with required altId and altType in Highlevel. Returns success boolean indicating deletion status.
- **highlevel_invoice_schedules_cancel** — Cancel a scheduled invoice by scheduleId in Highlevel. Requires altId and altType in the request body. Returns schedule details including _id, status, liveMode, altId, altType, name, schedule info, invoices list with invoice details, businessDetails, currency, contactDetails, discount, items, total, title, termsNotes, compiledTermsNotes, createdAt, and updatedAt.
- **highlevel_invoice_schedules_auto_payment** — Manage auto payment for a schedule invoice in Highlevel using schedule id. Returns schedule details including status, liveMode, altId, altType, name, schedule execution rules, and list of invoices with key fields such as invoice id, status, amountPaid, currency, contactDetails, issueDate, dueDate, total, and payment schedule.
- **list_all_highlevel_invoice** — List invoices filtered by altId, altType, limit, and offset in Highlevel. Returns invoice fields including _id, status, amountPaid, invoiceNumber, contactDetails, issueDate, dueDate, total, amountDue, and createdAt.
- **get_single_highlevel_invoice_by_id** — Get invoice by id with required parameters alt_id and alt_type in Highlevel. Returns invoice fields including _id, status, amountPaid, name, invoiceNumber, currency, issueDate, dueDate, total, amountDue, createdAt, updatedAt, and businessDetails.
- **create_a_highlevel_invoice** — Create an invoice in Highlevel with required fields altId, altType, name, businessDetails, currency, items, discount, contactDetails, issueDate, sentTo, liveMode, paymentSchedule, lateFeesConfiguration, tipsConfiguration, and paymentMethods. Returns the created invoice details.
- **update_a_highlevel_invoice_by_id** — Update invoice by id in Highlevel. Requires invoiceId as path parameter and altId, altType, name, currency, issueDate, dueDate, contactDetails, invoiceItems, paymentSchedule, tipsConfiguration, and stripe payment method in the body. Returns updated invoice details including invoice number, status, and amounts.
- **delete_a_highlevel_invoice_by_id** — Delete invoice by id in Highlevel. Requires id, altId (location or company id), and altType (must be 'location').
- **highlevel_invoice_generate_invoice_number** — Get a generated invoice number for a location in Highlevel. Requires altId (location id) and altType (must be 'location'). Returns the generated invoice number.
- **highlevel_invoice_late_fees_configuration** — Update invoice late fees configuration by invoice id in Highlevel. Requires invoiceId, altId, altType, and lateFeesConfiguration including enable, value, type, frequency, grace, and maxLateFees. Returns updated lateFeesConfiguration.
- **highlevel_invoice_void_invoice** — Void invoice with id in Highlevel. Requires invoiceId as id, altId as location or company id, and altType as location. Returns confirmation of voided invoice.
- **highlevel_invoice_send_invoice** — Send invoice by id in Highlevel. Requires invoice id, altId, altType, userId, action, and liveMode. Returns confirmation of send status.
- **highlevel_invoice_record_invoice_payment** — Record a manual payment for an invoice by invoiceId in Highlevel. Requires altId, altType, mode, card or cheque details, notes, amount, and optional paymentScheduleIds. Records payment details and notes.
- **highlevel_invoice_invoice_last_visited** — Update invoice last visited at by invoiceId in Highlevel. Requires invoiceId in the request body.
- **create_a_highlevel_invoice_text_2_pay** — Create and send an invoice in Highlevel with required parameters altId, altType, name, currency, items, contactDetails, issueDate, sentTo, liveMode, paymentSchedule, lateFeesConfiguration, tipsConfiguration, action, and userId. Returns invoice id, status, and total amount.
- **list_all_highlevel_invoice_estimates** — Get a paginated list of estimates in Highlevel using altId, altType, limit, and offset. Returns estimates array, total count, and traceId for request tracing.
- **create_a_highlevel_invoice_estimate** — Create a new estimate in Highlevel with altId, altType, name, currency, items, discount, contactDetails, and frequencySettings. Returns the created estimate including estimateNumber, issueDate, expiryDate, and total amount.
- **update_a_highlevel_invoice_estimate_by_id** — Update an estimate by id in Highlevel. Requires estimateId as path parameter and body with altId, altType, name, businessDetails, currency, items, discount, contactDetails, discount type, frequencySettings, and other required fields. Returns updated estimate details including estimateStatus, estimateNumber, and contact information.
- **delete_a_highlevel_invoice_estimate_by_id** — Delete an existing estimate by id in Highlevel. Requires altId and altType in the request body. altType must be 'location'.
- **highlevel_invoice_estimates_estimate_number** — Get the next estimate number for the given location in Highlevel. Requires altId and altType. Returns estimate_number as the next available estimate number.
- **highlevel_invoice_estimates_send** — Send estimate by estimateId in Highlevel. Requires estimateId, altId, altType, action, liveMode, and userId. Returns confirmation of sending status.
- **highlevel_invoice_estimates_invoice_from_estimate** — Create a new invoice from an existing estimate using estimateId. Requires altId (Location or Agency Id), altType (must be 'location'), markAsInvoiced (boolean), and version ('v1v2').
- **highlevel_invoice_estimates_last_visited_at** — Update estimate last visited at by estimateId in Highlevel. Requires estimateId in the request body.
- **list_all_highlevel_invoice_estimate_templates** — Get a list of estimate templates using altId, altType, limit, and offset. Returns template id, name, and details in Highlevel.
- **create_a_highlevel_invoice_estimate_template** — Create a new estimate template in Highlevel with required parameters altId, altType, name, currency, items, and discount. Returns the created estimate template details including id, name, and currency.
- **update_a_highlevel_invoice_estimate_template_by_id** — Update an existing estimate template in Highlevel using id. Requires altId, altType, name, businessDetails, currency, items, discount, and other fields. Returns updated template data including template id, name, and currency.
- **delete_a_highlevel_invoice_estimate_template_by_id** — Delete an estimate template by id in Highlevel. Requires id as templateId, altId as Location or Agency Id, and altType as 'location'.
- **highlevel_invoice_estimate_templates_preview** — Get a preview of an estimate template in Highlevel using altId, altType, and templateId. Returns the template preview details.
- **list_all_highlevel_trigger_links** — Get links for a specific location in Highlevel using location_id. Returns id, name, redirectTo, fieldKey, and locationId for each link.
- **create_a_highlevel_trigger_link** — Create Link with locationId, name, and redirectTo in Highlevel. Returns the created link details including id, name, locationId, and redirectTo.
- **update_a_highlevel_trigger_link_by_id** — Update link by id in Highlevel. Requires id, name, and redirectTo. Returns updated link fields: id, name, redirectTo, fieldKey, and locationId.
- **delete_a_highlevel_trigger_link_by_id** — Delete a link by id in Highlevel. Requires id.
- **list_all_highlevel_time_zone** — Get available timezones for a specific location in Highlevel. Requires location_id. Returns the list of timezones available for the location.
- **list_all_highlevel_media_library** — Get list of files and folders in Highlevel media library with required parameters altId, altType, sortBy, sortOrder. Returns file and folder details including metadata.
- **create_a_highlevel_media_library** — Upload a file to the Media Library in Highlevel. Requires file if hosted is false or fileUrl if hosted is true. Maximum file size is 25 MB. Returns data about the uploaded file including its name and parentId.
- **delete_a_highlevel_media_library_by_id** — Delete a specific file or folder from the media library in Highlevel using id, altId, and altType. Returns confirmation of deletion.
- **update_a_highlevel_media_library_by_id** — Updates a single file or folder by id.
- **highlevel_media_library_update_files** — Updates metadata or status of multiple files and folders.
- **highlevel_media_library_delete_files** — Soft-deletes or trashes multiple files and folders in a single request.
- **highlevel_media_library_create_folder** — Creates a new folder in the media storage.
- **list_all_highlevel_wallet_charges** — Get all wallet charges filtered by startDate and endDate in Highlevel. Returns charges with fields such as eventId, meterId, userId, and timestamps.
- **get_single_highlevel_wallet_charge_by_id** — Get specific wallet charge details by id in Highlevel. Returns detailed information about the charge including its ID and related billing data.
- **create_a_highlevel_wallet_charge** — Create a new wallet charge in Highlevel with required parameters appId, meterId, eventId, locationId, companyId, description, and units. Returns details of the created charge.
- **delete_a_highlevel_wallet_charge_by_id** — Delete a wallet charge by id in Highlevel.
- **highlevel_wallet_charges_sufficient_funds** — Get information to check if an account has sufficient funds in Highlevel. Returns has_funds indicating fund availability.
- **list_all_highlevel_redirect** — Get a list of URL redirects in Highlevel using locationId, limit, and offset. Returns redirects with details such as source URL and target URL.
- **create_a_highlevel_redirect** — Create a new URL redirect in Highlevel with required parameters locationId, domain, path, target, and action. Returns the created redirect details including locationId, domain, path, target, and action.
- **update_a_highlevel_redirect_by_id** — Update an existing URL redirect by id in Highlevel. Requires id, target URL, action (must be 'funnelwebsiteurlall'), and locationId. Returns the updated redirect details.
- **delete_a_highlevel_redirect_by_id** — Delete a redirect by id in Highlevel. Requires id and locationId. Deletes the URL redirect identified by id.
- **list_all_highlevel_funnels** — Get list of funnels with parameters category, limit, name, offset, parentId, type, and locationId in Highlevel. Returns funnel details including id, name, and type.
- **highlevel_funnels_funnel_pages** — Get list of funnel pages by funnel_id, limit, location_id, and offset in Highlevel. Returns funnel page details including name and identifiers.
- **highlevel_funnels_funnel_pages_count** — Get count of funnel pages for funnel_id and location_id in Highlevel. Returns the total count of pages matching the specified funnel and location.
- **list_all_highlevel_integration_providers** — List white-label integration providers in Highlevel filtered by altId and altType. Returns provider id, name, and description fields.
- **create_a_highlevel_integration_provider** — Create a white-label integration provider in Highlevel with altId, altType, uniqueName, title, provider, description, and imageUrl. Returns the created provider's details including uniqueName and title.
- **list_all_highlevel_orders** — List orders filtered by altId and altType in Highlevel. Returns order id, name, status, payment mode, and contactId fields in the response.
- **get_single_highlevel_order_by_id** — Get order details by id, altId, and altType in Highlevel. Returns order id, status, amount, and customer info. Requires order id as path parameter and altId, altType as query parameters.
- **list_all_highlevel_order_fulfillment** — List all fulfillment history of an order in Highlevel. Requires orderId as id, altId as Location or Agency Id, and altType with value 'location'. Returns fulfillment details of the order.
- **create_a_highlevel_order_fulfillment** — Create order fulfillment for order with id. Requires altId, altType as 'location', trackings with trackingNumber, shippingCarrier, trackingUrl, items with priceId and qty, and notifyCustomer. Returns fulfillment details.
- **list_all_highlevel_transactions** — List transactions filtered by altId and altType in Highlevel. Returns transaction id, name, status, payment mode, and date fields in the response.
- **get_single_highlevel_transaction_by_id** — Get information about a specific transaction by id in Highlevel. Requires id, altId, and altType. Returns transaction details including transactionId, amount, status, and date.
- **list_all_highlevel_subscriptions** — List subscriptions filtered by altId and altType in Highlevel. Returns subscription id, name, status, payment mode, contactId, entityId, and date fields in the response.
- **get_single_highlevel_subscription_by_id** — Get subscription details by id and altId in Highlevel. Returns subscription fields including subscriptionId, altId, altType, and related subscription information.
- **list_all_highlevel_coupons** — Get a list of coupons for location using altId and altType. Returns coupon id, name, code, status, and discount details.
- **get_single_highlevel_coupon_by_id** — Get detailed information about a specific coupon in Highlevel using id. Returns coupon parameters, usage statistics, validity periods, and promotional details.
- **create_a_highlevel_coupon** — Create a new promotional coupon in Highlevel with required parameters altId, altType, name, code, discountType, discountValue, and startDate. The response returns the created coupon details including id, name, code, discountType, discountValue, startDate, and usage limits.
- **update_a_highlevel_coupon_by_id** — Update coupon details including name, code, discount type and value, startDate, endDate, usageLimit, productIds, and subscription applicability in Highlevel. Requires id, altId, altType, name, code, discountType, discountValue, startDate, and type.
- **delete_a_highlevel_coupon_by_id** — Delete a coupon using id, altId, and altType in Highlevel. This permanently removes the coupon and cannot be undone.
- **list_all_highlevel_products** — List products filtered by locationId in Highlevel. Returns product id, name, and other details. Requires locationId parameter.
- **get_single_highlevel_product_by_id** — Get product details by id and location_id in Highlevel. Returns product id, name, description, price, and availability status.
- **create_a_highlevel_product** — Create a product with name, locationId, and productType in Highlevel. Returns the created product including id, name, description, productType, and availability status.
- **update_a_highlevel_product_by_id** — Update product by id in Highlevel. Requires id, name, locationId, and productType. Returns updated product details including name, description, image URL, statementDescriptor, availability, medias with id, title, url, type, isFeatured, and variants with id, name, and options.
- **delete_a_highlevel_product_by_id** — Delete a product by id and location_id in Highlevel. Returns no content on success.
- **list_all_highlevel_price** — List prices for a product using product_id and locationId in Highlevel. Returns price id, amount, currency, and locationId fields in the response.
- **get_single_highlevel_price_by_id** — Get price details for a specific price id and product id in Highlevel with required locationId. Returns fields _id, membershipOffers, variantOptionIds, locationId, product, userId, name, type, currency, amount, recurring, createdAt, updatedAt, compareAtPrice, trackInventory, availableQuantity, and allowOutOfStockPurchases.
- **create_a_highlevel_price** — Create Price for a Product using product_id. Requires name, type, currency, amount, locationId, source, stripePriceId, and internalSource. Returns created price details including id, name, amount, currency, and type.
- **update_a_highlevel_price_by_id** — Update price by id for a product using product_id and id in Highlevel. Returns updated price fields including name, type, currency, amount, recurring details, locationId, source, stripePriceId, and inventory tracking info.
- **delete_a_highlevel_price_by_id** — Delete a specific price by id for a product using product_id and locationId in Highlevel. Requires locationId as a query parameter.
- **list_all_highlevel_snapshots** — Get a list of all own and imported Snapshots for company_id. Returns snapshots with details including snapshot id, name, and import status.
- **create_a_highlevel_snapshot** — Create a share link for a snapshot in Highlevel using companyId and snapshot_id. Specify share_type to define the link type. Returns the generated share link details.
- **highlevel_snapshots_push_dates** — Get list of sub-accounts snapshot pushed between from and to dates for companyId in Highlevel. Returns sub-account snapshot details including snapshotId and timestamp.
- **highlevel_snapshots_last_push** — Get the latest snapshot push status for a location in Highlevel using snapshotId and locationId. Returns snapshotStatus indicating the current push state.
- **list_all_highlevel_google_business_locations** — Get Google business locations for Highlevel using location_id and accountId. Returns location details including address, name, and status.
- **create_a_highlevel_google_business_location** — Set google business locations using location_id and account_id in Highlevel. Requires location object with companyId. Returns confirmation of the set location.
- **list_all_highlevel_accounts** — Get list of accounts for location_id in Highlevel. Returns accounts array with account details.
- **delete_a_highlevel_account_by_id** — Delete account by id and location_id in Highlevel. Removes the account and its group association.
- **highlevel_google_oauth_starts_oauth** — Start OAuth process for Google account in Highlevel. Opens Google login screen and listens for event data including actionType, page, platform, placement, accountId, and reconnectAccounts.
- **list_all_highlevel_posts** — Get posts for location_id in Highlevel. Returns posts array with fields like _id, source, platform, displayDate, accountId, postId, publishedAt, summary, media, status, type, tags, and user details. Requires type, accounts, skip, limit, fromDate, toDate, and includeUsers.
- **get_single_highlevel_post_by_id** — Get post by id and location_id in Highlevel. Returns fields including _id, source, platform, displayDate, createdAt, updatedAt, accountId, error, postId, publishedAt, summary, media, status, createdBy, type, tags, ogTagsDetails, postApprovalDetails, tiktokPostDetails, gmbPostDetails, and user.
- **create_a_highlevel_post** — Create posts for the location_id in Highlevel. Returns post details including _id, source, locationId, platform, displayDate, createdAt, updatedAt, accountId, error, postId, publishedAt, accountIds, summary, media, status, createdBy, type, tags, ogTagsDetails, postApprovalDetails, tiktokPostDetails, gmbPostDetails, and user.
- **update_a_highlevel_post_by_id** — Edit post by id and location_id in Highlevel. Returns updated post details including status, scheduleDate, approvalStatus, and media information.
- **delete_a_highlevel_post_by_id** — Delete post by id and location_id in Highlevel.
- **list_all_highlevel_facebook** — Get Facebook pages for a specific account using location_id and id in Highlevel. Returns details of Facebook pages associated with the account.
- **create_a_highlevel_facebook** — Attach Facebook pages using location_id and account_id in Highlevel. Requires page details including originId, name, avatar, and companyId in the request body.
- **highlevel_facebook_starts_oauth** — Get Facebook account details by id in Highlevel. Requires id as accountId path parameter. Returns account information including page, platform, and placement fields.
- **list_all_highlevel_instagram** — Get Instagram Professional Account by location_id and id in Highlevel. Returns id, name, avatar, pageId, and isConnected status of the account.
- **create_a_highlevel_instagram** — Attach an Instagram Professional Account using location_id and id. Requires pageId in the body. Returns details of the attached account including originId, name, avatar, and companyId if provided.
- **highlevel_instagram_starts_oauth** — Start OAuth login for Instagram account with required locationId and userId in Highlevel. Opens Instagram login screen and listens for authentication message.
- **list_all_highlevel_linkedin** — Get LinkedIn pages and profile for account with accountId and locationId in Highlevel. Returns pages and profile details including key LinkedIn account information.
- **create_a_highlevel_linkedin** — Attach LinkedIn pages and profile using location_id and account_id in Highlevel. The response includes confirmation of the attached page or profile details.
- **highlevel_linkedin_starts_oauth** — Get LinkedIn account details using id. Requires id. Returns account information including accountId and platform details in Highlevel integration.
- **create_a_highlevel_csv** — Upload CSV file to Highlevel for location_id. Returns filePath, rowsCount, and fileName in the response.
- **delete_a_highlevel_csv_by_id** — Delete CSV by id and location_id in Highlevel. Returns csv details including locationId, fileName, accountIds, file, status, count, createdBy, traceId, originId, and approver.
- **highlevel_csv_set_accounts** — Set accounts for a specific location in Highlevel using location_id. Requires accountIds, filePath, rowsCount, and fileName. rowsCount must be between 1 and the number of posts in the CSV.
- **highlevel_csv_csv_finalize** — Update CSV resource by id and location_id in Highlevel. Requires location_id and id.
- **delete_a_highlevel_csv_post_by_id** — Delete CSV Post with location_id, csv_id, and id in Highlevel.
- **get_single_highlevel_social_media_tag_by_id** — Get tags by tagIds for a specific location in Highlevel. Requires location_id and tagIds. Returns tag details including id and name.
- **list_all_highlevel_surveys** — Get surveys by locationId in Highlevel. Returns survey id, name, and locationId fields in the response.
- **highlevel_surveys_submissions** — Get survey submissions filtered by locationId in Highlevel. Returns id, contactId, createdAt, surveyId, name, email, and others fields in the response.
- **list_all_highlevel_custom_menu_links** — Get a collection of custom menu links filtered by locationId or showOnCompany in Highlevel. Returns custom menu configurations including menu items, categories, and metadata.
- **get_single_highlevel_custom_menu_link_by_id** — Get a custom menu link by id in Highlevel. Returns menu items, categories, and associated metadata for the specified custom menu.
- **create_a_highlevel_custom_menu_link** — Create a new custom menu link in Highlevel with required fields title, url, icon, showOnCompany, showOnLocation, showToAllLocations, openMode, locations, and userRole. Returns the created custom menu details including id, title, url, and icon.
- **update_a_highlevel_custom_menu_link_by_id** — Update a custom menu link by id in Highlevel. Returns the updated custom menu including title, url, icon details, visibility settings, open mode, locations, user role, and permissions for camera and microphone access.
- **delete_a_highlevel_custom_menu_link_by_id** — Delete a specific custom menu link by id in Highlevel. Requires the id of the custom menu link to remove it from the system.
- **create_a_highlevel_tiktok** — Attach TikTok profile to an account using location_id and accountId. Returns confirmation of attachment with profile details such as name, username, avatar, and verification status.
- **highlevel_tiktok_business_profile** — Get Tiktok Business profile by location_id and id. Returns profile details including account information.
- **highlevel_tiktok_oauth_starts_oauth** — Start OAuth process for Tiktok account in Highlevel. Opens Tiktok login OAuth screen and returns event data including actionType, page, platform, placement, accountId, and reconnectAccounts.
- **highlevel_tiktok_oauth_business_oauth** — Start OAuth for TikTok Business Account with required locationId and userId parameters. Opens TikTok Business login screen and listens for login success message.
- **list_all_highlevel_calendar_appointment_notes** — Get appointment notes for appointment id in Highlevel. Returns notes array with id, body, userId, dateAdded, contactId, createdBy (id, name), and hasMore indicating more notes availability.
- **create_a_highlevel_calendar_appointment_note** — Create a note for an appointment in Highlevel. Returns note id, body, userId, dateAdded, contactId, and createdBy details.
- **update_a_highlevel_calendar_appointment_note_by_id** — Update a note for an appointment in Highlevel using appointment_id and id. Returns updated note fields: id, body, userId, dateAdded, contactId, and createdBy with creator's id and name.
- **delete_a_highlevel_calendar_appointment_note_by_id** — Delete a note by id for a specific appointment in Highlevel. Requires appointment_id and id. Returns success boolean indicating deletion status.
- **highlevel_custom_provider_delete_association** — Delete an association for an app and location.
- **highlevel_custom_provider_create_association** — Create a new association for an app and location.
- **highlevel_store_set_priority** — To set the display priority of products in a store.
- **highlevel_calendar_schedules_remove_calendar_availability** — Removes the association between a team calendar and the given schedule by removing the calendarId from the schedule
- **list_all_highlevel_contact_tasks** — List all contact-tasks for a given contact_id in Highlevel. Returns id, title, body, assignedTo, dueDate, completed, and contactId fields for each task.
- **get_single_highlevel_app_by_id** — Fetches installer details for the authenticated user.
- **delete_a_highlevel_app_by_id** — Uninstalls an application from your company or a specific location. This will remove the application`s access and stop all its functionalities.
- **highlevel_external_authentication_migrate** — Migrates an external authentication connection credentials (basic or oauth2) for a specific app and location. This endpoint validates the app configuration, stores credentials safely in Highlevel's native encrypted storage. With this the lifecycle of the token is managed by Highlevel.
- **get_single_highlevel_social_planner_category_by_id** — Get category by id and location_id in Highlevel. Returns category details including id and related information.
- **list_all_highlevel_saas_locations** — Get locations by companyId, customerId, and subscriptionId in Highlevel. Returns location details including id, name, and address.
- **highlevel_saas_locations_enable** — Enable SaaS for sub-account with id in Highlevel. Requires locationId as id, companyId, and isSaaSV2. Returns confirmation data of the enabled SaaS sub-account. Available only on Agency Pro plan.
- **highlevel_saas_locations_disable** — Disable SaaS for locations with locationIds for a given company using Highlevel. Requires company id and locationIds array in the request body.
- **highlevel_saas_locations_update_rebilling** — Update rebilling for given locationIds in Highlevel. Requires companyId, product, locationIds, and config. Bulk updates rebilling settings for specified locations.

## How it works

1. **Link your customer's Highlevel account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app.
2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request.
3. **Call Truto's API to reach Highlevel.** The Proxy API is a 1-to-1 mapping of the Highlevel API.
4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field.

## Use cases

- **Push captured leads directly into Highlevel workflows** — If your SaaS captures leads via forms, quizzes, or webinars, you can create contacts in your users' Highlevel accounts and immediately inject them into pre-built marketing workflows or pipeline stages — no manual handoff required.
- **Sync AI conversation transcripts into the Highlevel inbox** — AI chatbot and voice agent platforms need a way to hand context back to the human sales rep. Pushing call transcripts, message logs, and recordings into Highlevel's unified Conversations inbox keeps everything in one place for your users' teams.
- **Book appointments on behalf of end users' clients** — Scheduling tools and AI receptionists can query real-time calendar availability in Highlevel, book events, and block slots — tying scheduling directly to the CRM contact record without requiring users to leave your product.
- **Map proprietary domain data into Highlevel Custom Objects** — Vertical SaaS products (property management, fleet tracking, healthcare) can sync complex operational data into Highlevel using Custom Objects and Custom Fields, enabling agencies to trigger automations based on domain-specific milestones.
- **Aggregate pipeline and contact data across agency sub-accounts** — Analytics and reporting platforms can pull contacts, opportunities, and pipeline data across multiple Highlevel Locations to give agency owners a consolidated view of performance across all their clients.

## What you can build

- **Automated lead-to-workflow routing** — Create contacts in Highlevel with tags and custom fields, then add them to specific workflows or campaigns based on lead source or qualification score using the workflows and campaigns APIs.
- **Real-time calendar availability and booking** — Query free slots from Highlevel calendars and create calendar events directly from your product, enabling features like AI-powered appointment scheduling for your users' end clients.
- **Two-way opportunity and pipeline sync** — Create, update, and track opportunities across Highlevel pipelines so your users' sales teams always see accurate deal stages and values without switching tools.
- **Unified conversation thread injection** — Push inbound and outbound messages, file attachments, and call recordings into Highlevel's Conversations inbox so sales reps have full interaction history alongside their CRM data.
- **Custom Object data mapping for vertical workflows** — Define custom objects and sync domain-specific records (e.g., properties, vehicles, policies) into Highlevel, letting agencies build automations triggered by your product's data.
- **Cross-location reporting dashboard** — List locations, contacts, opportunities, and tasks across an agency's entire Highlevel account to power aggregate dashboards and performance benchmarks.

## FAQs

### Which Truto Unified APIs does Highlevel map to?

Highlevel is supported across the Unified CRM API (Contacts, Opportunities, Pipelines, Stages, Notes, Tasks, Users, Workspaces, Fields, Engagements), the Unified Marketing Automation API (Contacts, Tags, Automations, Users, Workspaces), and the Unified User Directory API (Users, Roles, Workspaces).

### How does authentication work for Highlevel integrations through Truto?

Truto manages the OAuth flow for Highlevel. Your end users connect their Highlevel account through Truto's auth flow, and Truto handles token storage, refresh, and session management so you never deal with credential lifecycle directly.

### Does the integration support Highlevel's multi-tenant Location model?

Yes. You can list, create, update, and delete Locations (sub-accounts) via the API. You can also manage SaaS-specific operations like enabling or disabling Locations and updating rebilling settings, which is critical for agency-focused workflows.

### Can I work with Highlevel Custom Objects and Custom Fields?

Yes. The integration supports full CRUD operations on Custom Objects, Custom Object Records, and Custom Fields — so you can define your own data models in Highlevel and sync domain-specific records from your product.

### What contact and opportunity operations are supported?

Full CRUD on contacts and opportunities, plus adding/removing followers, managing tags, searching for duplicates, adding contacts to campaigns and workflows, and updating opportunity status. Pagination is handled by Truto automatically.

### Can I interact with Highlevel's Conversations and messaging features?

Yes. You can create and manage conversations, send inbound and outbound messages, attach files, list message recordings and transcriptions, and push chat messages via custom providers — enabling deep inbox integration for AI agents and communication tools.
