Authentication: Private integration token or OAuth. See Magic Link for the runtime auth flow, or Application credentials to bring your own OAuth app.
Sample use cases
- Create a contact for
jane.doe@example.comand add thewebinar-leadtag - List the opportunities in the
Sales Pipelinethat moved toWonthis month - Book an appointment on the
Discovery Callcalendar for Friday at 10am
Available Tools
Add one or more tags to a contact. Tags that don’t exist yet are created. Use list_contacts to find contact IDs. Retu…
Check whether a blog post URL slug is already in use for a location. Call this before create_blog_post or before chan…
Book an appointment on a calendar. calendarId, locationId, contactId, and startTime are required. Use list_calendars…
Create a blog post on a blog site. location_id, blog_id, raw_html, and status are required. Use list_blogs for blog_i…
Create a contact in a location. location_id is required: use search_locations to find it. Returns the new contact ID…
Create a note on a contact. body is required. Use list_contacts to find contact IDs. Returns the new note ID.
Create a task on a contact. title, dueDate, and completed are all required (pass completed=false for a new open task)…
Create an email builder template in a location. location_id and type are required: use search_locations for location_…
Create an opportunity. pipelineId, locationId, name, status, and contactId are required. Call list_pipelines first to…
Create a social media post for connected accounts. location_id and type are required; use search_locations for locati…
Permanently delete an appointment (calendar event) by ID. This cannot be undone. Use list_calendar_events or get_appo…
Permanently delete a contact by ID. This cannot be undone. Use list_contacts to find contact IDs.
Permanently delete a note on a contact. Use list_contact_notes to find note IDs and list_contacts for contact IDs.
Permanently delete a task on a contact. Use list_contact_tasks to find task IDs and list_contacts for contact IDs.
Delete an email builder template (the inverse of create_email_template). location_id and template_id are required: us…
Permanently delete an opportunity by ID. This cannot be undone. Use search_opportunities to find opportunity IDs.
Delete a social media post (the inverse of create_social_post). location_id and post_id are required: use search_loca…
Fetch one appointment (calendar event) by ID. Use list_calendar_events to find event IDs.
Fetch one calendar by ID. Use list_calendars to find calendar IDs.
Fetch one contact by ID. Use list_contacts to find contact IDs.
Fetch one note on a contact by ID. Use list_contact_notes to find note IDs and list_contacts for contact IDs.
Fetch one task on a contact by ID. Use list_contact_tasks to find task IDs and list_contacts to find contact IDs.
Fetch one HighLevel location (sub-account) by ID. Use search_locations to find location IDs.
Fetch one opportunity by ID. Use search_opportunities to find opportunity IDs.
Fetch one payment order by ID. location_id is required (sent as the API’s altId): use search_locations to find it. Fi…
Retrieve social media analytics for connected accounts over a date range, with an optional comparison period. locatio…
Fetch one social media post by ID. location_id and post_id are required: use search_locations for location_id and lis…
List notes attached to an appointment, with limit/offset paging. Use list_calendar_events or get_appointment to find…
List blog authors in a location with search and limit/offset paging. location_id is required: use search_locations to…
List blog categories in a location with search and limit/offset paging. location_id is required: use search_locations…
List blog posts for a blog site with search and status filters and limit/offset paging. location_id and blog_id are r…
List blog sites in a location. location_id is required: use search_locations to find it. Returns blog site IDs for li…
List calendar events (appointments) in a location. location_id, start_time, and end_time (an epoch-ms window) are all…
List calendars in a location. location_id is required: use search_locations to find it. Returns calendar IDs for get_…
List all notes on a contact. Use list_contacts to find contact IDs. Returns note IDs for get/update/delete_contact_note.
List all tasks on a contact. Use list_contacts to find contact IDs. Returns task IDs for get/update/delete_contact_task.
List contacts in a location with free-text search and limit paging. location_id is required: use search_locations to…
List messages in a conversation, newest first, with limit paging. Use search_conversations to find conversation IDs…
List a location’s custom field definitions (ID, name, key, data type, picklist options). location_id is required: use…
List email builder templates for a location with search and limit/offset paging. location_id is required: use search_…
List opportunity pipelines and their stages in a location. location_id is required: use search_locations to find it…
List connected social media accounts and groups for a location. location_id is required: use search_locations to find…
List social media posts in a location with status, account, post-type, and date-range filters plus limit/skip paging…
List payment transactions in a location with filters for contact, subscription, entity, date range, payment mode, and…
Remove one or more tags from a contact (the inverse of add_contact_tags). Use list_contacts to find contact IDs. Retu…
Search conversations in a location with filters for contact, assignee, status, last-message type/direction, free-text…
Search HighLevel locations (sub-accounts) with offset paging. Use this to discover location IDs required by list_cont…
Search opportunities in a location with server-side filters. location_id is required: use search_locations to find it…
Send a new message to a contact on a channel (SMS, Email, WhatsApp, IG, FB, Custom, Live_Chat). type, contact_id, and…
Update an existing blog post. post_id, location_id, blog_id, raw_html, and status are required. Use list_blog_posts f…
Update a contact’s fields. Only the fields you pass are changed. Use list_contacts to find contact IDs.
Update a note on a contact. body is required. Use list_contact_notes to find note IDs and list_contacts for contact IDs.
Update a task on a contact. Only the fields you pass are changed. Use list_contact_tasks to find task IDs and list_co…
Update an opportunity’s fields. Only the fields you pass are changed. Use search_opportunities to find opportunity ID…
Update a social media post. location_id, post_id, and type are required; use search_locations for location_id, list_s…
Create a contact, or update the existing one that matches by email/phone per the location’s ‘Allow Duplicate Contact’…