# Highlevel MCP connector

The Highlevel connector brings your Highlevel contacts, locations, pipelines, tags and custom fields to Claude, ChatGPT, Cursor and other AI clients, so your team can look up, update and organize CRM records by asking in plain language.

Source: https://elaichi.ai/connectors/highlevel/

## Facts

| | |
| --- | --- |
| Application | Highlevel |
| Category | CRM |
| AI tools | 297 |
| Authentication | OAuth or API key |
| Needs your own OAuth app | Yes |
| MCP endpoint | https://api.elaichi.ai/mcp |
| Works with | Claude, ChatGPT, Cursor, any MCP client, and the Elaichi Agent |
| Tools advertised by name | No. 297 tools is past the 30-tool threshold, so clients use `search_tools` and `execute_tool` |

## What you can ask once Highlevel is connected

- List Highlevel contacts added to the London location this week.
- Which Highlevel custom fields are empty on new contacts?
- Add me as a follower on these three Highlevel contacts.

## Connect Highlevel in Elaichi

This happens once for the organization, before any client is involved.

1. Open Connections, choose Add connection, and pick Highlevel.
2. Optionally set Share with, then press Connect.
3. Supply your own Highlevel app, then approve. Highlevel needs an OAuth app you register yourself, so bring its client ID and secret. One person does this once for the organization.

Credentials are vaulted and nobody, including the AI, reads them back. The connection becomes a toolbox immediately, so you can curate which Highlevel tools are exposed, rename them, or freeze arguments before anyone points a client at it.

## Connect Highlevel to Claude

Endpoint: https://api.elaichi.ai/mcp

1. Open Customize, then Connectors.
2. Press Add.
3. Name it, paste the MCP server URL, then Continue.
4. Sign in and approve.

On Team and Enterprise, an Owner adds it once. Everyone else turns it on for themselves.

## Connect Highlevel to ChatGPT

Endpoint: https://api.elaichi.ai/mcp

1. Open Plugins, then press the + button.
2. Name it and paste the endpoint into Server URL.
3. Leave Authentication on OAuth, then tick the risk acknowledgement.
4. Press Create, then sign in and approve.

Works on the web today. The plugin directory lives at chatgpt.com/plugins.

## Connect Highlevel to Cursor

Endpoint: https://api.elaichi.ai/mcp

1. Open `~/.cursor/mcp.json`.
2. Add the endpoint under `mcpServers`.
3. Reload Cursor, then sign in and approve.

Set up per machine, so repeat it on each computer you work from.

## Connect Highlevel to any MCP client

Endpoint: https://api.elaichi.ai/mcp

1. Add the endpoint as a remote MCP server.
2. Sign in and approve.

The Elaichi Agent already has these tools, with nothing to set up.

## What the consent screen decides

Only Read is granted by default, which is not enough to call a Highlevel tool. Over MCP there is no trusted place to confirm a write in the moment, so the consent screen is the standing approval rather than a formality. Grant Read and Run tools. Think hard before granting Delete, which reaches into connected apps and cannot be undone.

## What teams do with Highlevel through Elaichi

### Catch a contact up after a call

Sales. Tell the agent what changed on the call and it updates the Highlevel contact, applies the right tag and adds the rep who now owns the relationship as a follower.

### Tag contacts for the next campaign

Marketing. Search Highlevel for contacts that match a segment, such as everyone in a city or with a given custom field value, and apply a campaign tag to all of them in one ask.

### Set up a new client sub-account

Agency operations. Create the Highlevel location for a new client, add the custom fields their intake form needs and create the starting set of tags, without clicking through every settings screen.

### Find who is on the line

Support. Ask for a caller by name, phone or email and get the Highlevel contact record, its tags and its custom field values before you say hello.

### Keep pipelines and fields consistent

Revenue operations. List every pipeline and custom field across your Highlevel locations, spot duplicates or drift, and rename or remove the ones that no longer belong.

### Hand accounts over cleanly

Customer success. When an account manager changes, remove the old follower and add the new one across every affected Highlevel contact, then tag them for the welcome sequence.

## Frequently asked questions

### How do I connect Highlevel to Claude?

First connect Highlevel inside Elaichi, then paste the endpoint https://api.elaichi.ai/mcp into Claude under Customize, then Connectors, then Add. Highlevel requires an OAuth application registered in your own Highlevel account, so one person brings that client ID and secret to Elaichi once, or uses a Highlevel API key instead. After that, everyone else signs in with their normal Highlevel login and never touches a key or secret.

### Does Highlevel work with ChatGPT and Cursor as well as Claude?

Yes. Once Highlevel is connected in Elaichi, the same endpoint, https://api.elaichi.ai/mcp, works in Claude, ChatGPT, Cursor, any other MCP client and the Elaichi Agent. You connect Highlevel once and every client your team uses can reach it.

### What can an AI agent actually do with my Highlevel data?

It can find a Highlevel contact by name, email or phone, create new contacts, update details, apply or remove tags and add or remove followers. It can also list your pipelines, locations and custom fields, and create or tidy up locations, tags and custom fields when you ask. Because Highlevel offers a large set of actions, short concrete asks such as "tag Maria Lopez as VIP" work better than long paragraphs.

### Does connecting Highlevel give the AI access to every location and sub-account?

No. Each person signs in to Highlevel as themselves, so the AI only sees the locations, contacts and pipelines that person can already see in Highlevel. Elaichi can narrow that further with restrictions, but it can never widen access beyond what Highlevel grants the signed-in user.

### Can my team share one Highlevel connection?

Yes. One person registers the Highlevel OAuth application or API key in Elaichi and shares the connection with a team, so nobody else ever handles a credential. Each teammate still signs in to Elaichi as themselves, so the audit log names the actual person behind every change to a Highlevel contact or location.

### Can I stop an agent from deleting or changing things in Highlevel?

Yes. In Elaichi you restrict actions one by one, so you can allow reading and updating Highlevel contacts while blocking deletion of contacts, locations, tags or custom fields. A blocked action is never shown to Claude, ChatGPT or any other client, so no prompt, accidental or otherwise, can reach it.

### What happens to a Highlevel connection when someone leaves?

Offboard the person in Elaichi and their access to Highlevel through every AI client ends at once. A Highlevel connection they shared keeps working for everyone else on the team. If you want to remove Highlevel entirely, disconnect it once in Elaichi and it disappears from Claude, ChatGPT, Cursor and every other client at the same time.

## All 297 Highlevel tools

Every tool below is callable through https://api.elaichi.ai/mcp once Highlevel is connected, subject to the toolbox it is in and the restrictions on the caller.

- **List all Highlevel contacts** (List). 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). 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** (Create). 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). 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). Delete contact by id in Highlevel. Returns 'succeded' boolean indicating if the deletion was successful.
- **Highlevel contacts add followers** (Add). 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** (Delete). 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** (List). 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). 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). 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). 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** (List). 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). 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). 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). 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). Delete a custom field by id and location_id in Highlevel.
- **List all Highlevel pipelines** (List). Get pipelines for location in Highlevel. Returns id, name, stages, showInFunnel, showInPieChart, and locationId fields for each pipeline.
- **List all Highlevel search locations** (List). 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** (List). 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). Get tag by id in Highlevel. Returns tag fields name, locationId, and id.
- **Create a Highlevel tag** (Create). Create tag with name in Highlevel for location_id. Returns tag fields name, locationId, and id.
- **Update a Highlevel tag by ID** (Update). 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). Delete tag by location_id and id in Highlevel.
- **List all Highlevel search contacts** (List). 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** (Search). 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** (List). Get campaigns in Highlevel. Returns campaigns with fields id, name, status, and locationId.
- **Highlevel campaigns add contact** (Add). 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** (Delete). 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** (Delete). 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** (List). Get workflows for the location in Highlevel. Returns id, name, status, version, createdAt, updatedAt, and locationId for each workflow.
- **Highlevel workflows add contact** (Add). 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). 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** (List). 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). 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). 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). 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). 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** (List). Get all email or SMS templates in Highlevel. Returns template id, name, type, body, attachments, dateAdded, locationId, and urlAttachments.
- **List all Highlevel businesses** (List). 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). 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). Create a new business in Highlevel. Returns the created business object including its id and key details.
- **Update a Highlevel business by ID** (Update). 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). Delete a business by id in Highlevel. Returns a success boolean indicating if the deletion was successful.
- **Highlevel businesses add contacts** (Add). 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** (List). 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** (List). 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). 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). 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). 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). Delete opportunity by id in Highlevel. If the opportunity is successfully deleted, it returns a success status of true.
- **Highlevel opportunities status** (Action). 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). 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** (Delete). 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** (List). 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). 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). 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). 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). Delete a custom value by id in Highlevel. Returns 'succeded' boolean indicating success.
- **List all Highlevel notes** (List). 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). 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). 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). 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). 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** (List). 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). 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). 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). 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). Delete a task by contact_id and id in Highlevel. Returns succeded boolean indicating if the deletion was successful.
- **Highlevel tasks completed** (Action). 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** (List). 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). 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). Delete conversation details by id in Highlevel. Returns success boolean indicating if the deletion was successful.
- **Update a Highlevel conversation by ID** (Update). 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). Create a new conversation in Highlevel. Returns conversation id, dateUpdated, dateAdded, deleted flag, contactId, locationId, lastMessageDate, and assignedTo fields.
- **List all Highlevel appointments** (List). 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** (List). 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** (List). Get all calendars in Highlevel. Returns calendar details including id, name, eventType, calendarType, slotDuration, openHours, and teamMembers.
- **Get single Highlevel calendar by ID** (Get). Get calendar by id in Highlevel. Returns calendar fields including isActive, locationId, groupId, teamMembers, eventType, name, description, calendarType.
- **Create a Highlevel calendar** (Create). 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). 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). 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** (Block). 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** (List). 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** (List). Get all calendar groups in Highlevel. Returns groups with fields locationId, name, description, slug, isActive, and id.
- **Create a Highlevel calendar group** (Create). 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). 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). 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). Update the group by id in Highlevel. Returns group object with locationId, name, description, slug, isActive, and id fields.
- **Highlevel calendar groups disable** (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** (List). 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). 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). 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). 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). 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** (List). 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). 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). 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). 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). 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). 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). Delete calendar resource by id and resource_type in Highlevel. If the calendar resource is successfully deleted, it returns a success status of true.
- **List all Highlevel calendar notifications** (List). 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). 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). 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). 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). Delete notification by calendar_id and id in Highlevel. Returns a message indicating the result of the delete operation.
- **List all Highlevel business contacts** (List). 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** (Create). 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** (Delete). 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). 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** (List). 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). 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). 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). 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). 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). 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). 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). 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** (List). 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). 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** (Create). 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** (List). 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). 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** (Create). 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** (Delete). 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). 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** (Action). 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** (Action). 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** (Action). 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** (List). 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** (List). Get the recording transcription in Highlevel. Returns mediaChannel, sentenceIndex, startTime, endTime, transcript, and confidence fields.
- **Highlevel conversation message transcription download** (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** (List). 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** (List). 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). 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). 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). 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). 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** (Action). Get association by key_name in Highlevel. Returns locationId, id, key, firstObjectLabel, firstObjectKey, secondObjectLabel, secondObjectKey, and associationType fields.
- **Highlevel associations association by object key** (Action). 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** (List). 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). 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). 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). 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** (List). 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** (List). Get email templates in Highlevel. Returns fields: id, name, updatedBy, isPlainText, lastUpdated, dateAdded, previewUrl, version, and templateType.
- **Create a Highlevel email template** (Create). 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). 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). Delete an email template by location_id and id in Highlevel. Returns 'ok' indicating success and 'traceId' for request tracking.
- **List all Highlevel forms** (List). Get forms in Highlevel. Returns form id, name, locationId, and total number of forms.
- **Highlevel forms upload custom files** (Upload). 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** (List). Get form submissions in Highlevel. Returns id, contactId, createdAt, formId, name, email, and others fields in the response.
- **List all Highlevel invoice templates** (List). 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). 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). 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). 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). Delete invoice template by id in Highlevel. Returns success boolean indicating deletion status.
- **Highlevel invoice templates late fees configuration** (Action). 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** (Action). 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** (List). 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). 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). 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). 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). Delete schedule by id with required altId and altType in Highlevel. Returns success boolean indicating deletion status.
- **Highlevel invoice schedules cancel** (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** (Action). 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). 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). 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). 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). 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). Delete invoice by id in Highlevel. Requires id, altId (location or company id), and altType (must be 'location').
- **Highlevel invoice generate invoice number** (Generate). 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** (Action). 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** (Action). 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). 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** (Action). 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** (Action). Update invoice last visited at by invoiceId in Highlevel. Requires invoiceId in the request body.
- **Create a Highlevel invoice text 2 pay** (Create). 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** (List). 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). 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). 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). 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** (Action). 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). 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** (Action). 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** (Action). Update estimate last visited at by estimateId in Highlevel. Requires estimateId in the request body.
- **List all Highlevel invoice estimate templates** (List). 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). 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). 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). 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** (Action). Get a preview of an estimate template in Highlevel using altId, altType, and templateId. Returns the template preview details.
- **List all Highlevel trigger links** (List). 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). 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). 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). Delete a link by id in Highlevel. Requires id.
- **List all Highlevel time zone** (List). 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** (List). 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** (Create). 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). 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** (Update). Updates a single file or folder by id.
- **Highlevel media library update files** (Update). Updates metadata or status of multiple files and folders.
- **Highlevel media library delete files** (Delete). Soft-deletes or trashes multiple files and folders in a single request.
- **Highlevel media library create folder** (Create). Creates a new folder in the media storage.
- **List all Highlevel wallet charges** (List). 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). 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). 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). Delete a wallet charge by id in Highlevel.
- **Highlevel wallet charges sufficient funds** (Action). Get information to check if an account has sufficient funds in Highlevel. Returns has_funds indicating fund availability.
- **List all Highlevel redirect** (List). 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). 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). 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). Delete a redirect by id in Highlevel. Requires id and locationId. Deletes the URL redirect identified by id.
- **List all Highlevel funnels** (List). 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** (Action). 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** (Action). 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). 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). 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). 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). 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). 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). 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). 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). 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). 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). Get subscription details by id and altId in Highlevel. Returns subscription fields including subscriptionId, altId, altType, and related subscription information.
- **List all Highlevel coupons** (List). 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). 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). 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). 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). Delete a coupon using id, altId, and altType in Highlevel. This permanently removes the coupon and cannot be undone.
- **List all Highlevel products** (List). List products filtered by locationId in Highlevel. Returns product id, name, and other details. Requires locationId parameter.
- **Get single Highlevel product by ID** (Get). Get product details by id and location_id in Highlevel. Returns product id, name, description, price, and availability status.
- **Create a Highlevel product** (Create). 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). 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). Delete a product by id and location_id in Highlevel. Returns no content on success.
- **List all Highlevel price** (List). 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). 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). 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). 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). 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** (List). 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). 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** (Push). 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** (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** (List). 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** (Create). 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** (List). Get list of accounts for location_id in Highlevel. Returns accounts array with account details.
- **Delete a Highlevel account by ID** (Delete). Delete account by id and location_id in Highlevel. Removes the account and its group association.
- **Highlevel google oauth starts oauth** (Action). 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** (List). 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). 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). 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** (Update). 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). Delete post by id and location_id in Highlevel.
- **List all Highlevel facebook** (List). 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** (Create). 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** (Action). 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** (List). 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** (Create). 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** (Action). 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** (List). 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** (Create). 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** (Action). Get LinkedIn account details using id. Requires id. Returns account information including accountId and platform details in Highlevel integration.
- **Create a Highlevel CSV** (Create). Upload CSV file to Highlevel for location_id. Returns filePath, rowsCount, and fileName in the response.
- **Delete a Highlevel CSV by ID** (Delete). 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). 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** (Action). Update CSV resource by id and location_id in Highlevel. Requires location_id and id.
- **Delete a Highlevel CSV post by ID** (Delete). Delete CSV Post with location_id, csv_id, and id in Highlevel.
- **Get single Highlevel social media tag by ID** (Get). 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** (List). Get surveys by locationId in Highlevel. Returns survey id, name, and locationId fields in the response.
- **Highlevel surveys submissions** (Action). 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** (List). 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). 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). 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). 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). 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** (Create). 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** (Action). Get Tiktok Business profile by location_id and id. Returns profile details including account information.
- **Highlevel tiktok oauth starts oauth** (Action). 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** (Action). 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** (List). 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). 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). 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). 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). Delete an association for an app and location.
- **Highlevel custom provider create association** (Create). Create a new association for an app and location.
- **Highlevel store set priority** (Set). To set the display priority of products in a store.
- **Highlevel calendar schedules remove calendar availability** (Delete). Removes the association between a team calendar and the given schedule by removing the calendarId from the schedule
- **List all Highlevel contact tasks** (List). 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** (Get). Fetches installer details for the authenticated user.
- **Delete a Highlevel app by ID** (Delete). 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** (Action). 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). Get category by id and location_id in Highlevel. Returns category details including id and related information.
- **List all Highlevel saas locations** (List). Get locations by companyId, customerId, and subscriptionId in Highlevel. Returns location details including id, name, and address.
- **Highlevel saas locations enable** (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). 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). Update rebilling for given locationIds in Highlevel. Requires companyId, product, locationIds, and config. Bulk updates rebilling settings for specified locations.
