> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HighLevel

> How to set up the HighLevel connector, plus the actions that are available.

![HighLevel](https://stackone-logos.com/api/highlevel/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/highlevel/changelog.md)

[251 actions](#actions) · 2 auth methods

CRM
Scheduling
Marketing
IAM
Messaging
Payments
Documents

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/highlevel/guides/connector-profile/oauth-2-0.md)
>
> Requires a HighLevel Marketplace app. An Agency install reaches agency-level endpoints; a Sub-Account install reaches on...

> [card] [Private Integration Token · Connector Profile](https://docs.stackone.com/connectors/highlevel/guides/connector-profile/private-integration-token.md)
>
> No app registration required. A Sub-Account token with its sub-account id reaches that sub-account's CRM data; an Agency...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/highlevel/guides/link-account/oauth-2-0.md)

> [card] [Private Integration Token · Link Account](https://docs.stackone.com/connectors/highlevel/guides/link-account/private-integration-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

Private Integration Token

No auth methods found

Scopes

Select all
|
Clear

associations.readonly

associations.write

associations/relation.readonly

associations/relation.write

businesses.readonly

businesses.write

calendars.readonly

calendars.write

calendars/events.readonly

calendars/events.write

calendars/groups.readonly

calendars/groups.write

calendars/resources.readonly

calendars/resources.write

campaigns.readonly

companies.readonly

contacts.readonly

contacts.write

conversations.readonly

conversations.write

conversations/message.readonly

conversations/message.write

emails/campaigns.readonly

emails/campaigns.write

emails/stats.readonly

emails/templates.readonly

emails/templates.write

forms.readonly

invoices.readonly

invoices.write

invoices/estimate.readonly

invoices/estimate.write

invoices/schedule.readonly

invoices/schedule.write

invoices/template.readonly

invoices/template.write

links.readonly

links.write

locations.readonly

locations.write

locations/customFields.readonly

locations/customFields.write

locations/customValues.readonly

locations/customValues.write

locations/tags.readonly

locations/tags.write

locations/tasks.readonly

medias.readonly

medias.write

objects/record.readonly

objects/record.write

objects/schema.readonly

objects/schema.write

opportunities.readonly

opportunities.write

payments/coupons.readonly

payments/coupons.write

payments/orders.collectPayment

payments/orders.readonly

payments/orders.write

payments/subscriptions.readonly

payments/transactions.readonly

pipelines.create

pipelines.readonly

pipelines.write

products.readonly

products.write

products/prices.readonly

products/prices.write

socialplanner/account.readonly

socialplanner/post.readonly

socialplanner/post.write

surveys.readonly

users.readonly

users.write

workflows.readonly

workflows.write

No scopes found

251 actions

ActionDescriptionRequired scopes

Get All Associations For A Sub-Account Location`highlevel_get_all_associations_for_a_subaccount_location`

List all associations for a location, paginated with skip and limit.

`associations.readonly`

Get All Relations By Record ID`highlevel_get_all_relations_by_record_id`

List all relations for a record id, paginated with skip and limit.

`associations/relation.readonly`

Get Association By ID`highlevel_get_association_by_id`

Get a SYSTEM\_DEFINED or USER\_DEFINED association by id.

`associations.readonly`

Get Association By Object Keys`highlevel_get_association_by_object_keys`

Get associations by object key such as contacts, custom objects or opportunities.

`associations.readonly`

Get Association Key By Key Name`highlevel_get_association_key_by_key_name`

Get a standard or user defined association by its key name.

`associations.readonly`

Create Association`highlevel_create_association`

Create a custom association between contacts, custom objects or businesses.

`associations.write`

Create Relation For You Associated Entities`highlevel_create_relation_for_you_associated_entities`

Create a relation linking two records under an existing association.

`associations/relation.write`

Update Association By ID`highlevel_update_association_by_id`

Update the labels of an association.

`associations.write`

Delete Association`highlevel_delete_association`

Delete a USER\_DEFINED association by id.

`associations.write`

Delete Relation`highlevel_delete_relation`

Delete a relation by relationId.

`associations/relation.write`

Get Businesses By Location`highlevel_get_businesses_by_location`

List businesses of a location, offset paginated with limit and skip.

`businesses.readonly`

Get Business`highlevel_get_business`

Retrieve one business by businessId.

`businesses.readonly`

Create Business`highlevel_create_business`

Create a business in a location, needing name and locationId.

`businesses.write`

Update Business`highlevel_update_business`

Update a business by businessId.

`businesses.write`

Delete Business`highlevel_delete_business`

Delete a business by businessId.

`businesses.write`

Get Blocked Slots`highlevel_get_blocked_slots`

List blocked slots for a location within a time range.

`calendars/events.readonly`

Get Calendar Events`highlevel_get_calendar_events`

List calendar events for a location within a time range.

`calendars/events.readonly`

Get Notes`highlevel_get_notes`

List notes for an appointment. Paginated by limit and offset.

`calendars/events.readonly`

Get Appointment`highlevel_get_appointment`

Fetch one appointment by eventId.

`calendars/events.readonly`

Create Appointment`highlevel_create_appointment`

Book a new appointment on a calendar for a contact.

`calendars/events.write`

Create Appointment Note`highlevel_create_appointment_note`

Add a note to an existing appointment.

`calendars/events.write`

Create Block Slot`highlevel_create_block_slot`

Create a blocked time slot on a calendar.

`calendars/events.write`

Update Appointment`highlevel_update_appointment`

Update an existing appointment by eventId.

`calendars/events.write`

Update Appointment Note`highlevel_update_appointment_note`

Update the body of an existing appointment note.

`calendars/events.write`

Update Block Slot`highlevel_update_block_slot`

Update a blocked slot by eventId.

`calendars/events.write`

Delete Appointment Note`highlevel_delete_appointment_note`

Delete a note from an appointment by appointmentId and noteId.

`calendars/events.write`

Delete Event`highlevel_delete_event`

Delete a calendar event by eventId.

`calendars/events.write`

Get Groups`highlevel_get_groups`

List all calendar groups in a location.

`calendars/groups.readonly`

Create Calendar Group`highlevel_create_calendar_group`

Create a calendar group, needing locationId, name, description and slug.

`calendars/groups.write`

Disable Group`highlevel_disable_group`

Enable or disable a calendar group via isActive.

`calendars/groups.write`

Update Group`highlevel_update_group`

Update a calendar group's name, description and slug by groupId.

`calendars/groups.write`

Validate Group Slug`highlevel_validate_group_slug`

Check whether a calendar group slug is available in a location.

`calendars/groups.write`

Delete Group`highlevel_delete_group`

Delete a calendar group by groupId.

`calendars/groups.write`

Get Notifications`highlevel_get_notifications`

List notifications for a calendar based on query.

`calendars/events.readonly`

Get Notification`highlevel_get_notification`

Get one calendar notification by notificationId.

`calendars/events.readonly`

Create Notification`highlevel_create_notification`

Create one or more notifications for a single calendar.

`calendars/events.write`

Update Notification`highlevel_update_notification`

Update a calendar notification by id.

`calendars/events.write`

Delete Notification`highlevel_delete_notification`

Delete a calendar notification by id.

`calendars/events.write`

Get Calendar Resource`highlevel_get_calendar_resource`

Get a calendar resource by resourceType and id (Services V1).

`calendars/resources.readonly`

List Calendar Resources`highlevel_list_calendar_resources`

List calendar resources by resourceType and locationId, paginated with skip and limit (Services V1).

`calendars/resources.readonly`

Create Calendar Resource`highlevel_create_calendar_resource`

Create a calendar resource of a given resourceType (Services V1).

`calendars/resources.write`

Update Calendar Resource`highlevel_update_calendar_resource`

Update a calendar resource by resourceType and id (Services V1).

`calendars/resources.write`

Delete Calendar Resource`highlevel_delete_calendar_resource`

Delete a calendar resource by resourceType and id (Services V1).

`calendars/resources.write`

Get Calendars`highlevel_get_calendars`

List all calendars in a location.

`calendars.readonly`

Get Free Slots`highlevel_get_free_slots`

Get free slots for a calendar between a start and end date, optionally by timezone and user.

`calendars.readonly`

Get Calendar`highlevel_get_calendar`

Get a calendar by ID.

`calendars.readonly`

Create Calendar`highlevel_create_calendar`

Create a calendar in a location.

`calendars.write`

Update Calendar`highlevel_update_calendar`

Update a calendar by ID.

`calendars.write`

Delete Calendar`highlevel_delete_calendar`

Delete a calendar by ID.

`calendars.write`

Get Campaigns`highlevel_get_campaigns`

Get campaigns for a location.

`campaigns.readonly`

Get Company`highlevel_get_company`

Get a company by companyId. Requires an Agency token.

`companies.readonly`

Get All Notes`highlevel_get_all_notes`

List all notes for a contact.

`contacts.readonly`

Get Contact Note`highlevel_get_contact_note`

Fetch one contact note by contactId and note id.

`contacts.readonly`

Create Contact Note`highlevel_create_contact_note`

Create a note on a contact.

`contacts.write`

Update Contact Note`highlevel_update_contact_note`

Update an existing contact note by contactId and note id.

`contacts.write`

Delete Contact Note`highlevel_delete_contact_note`

Delete a contact note by contactId and note id.

`contacts.write`

Get All Tasks`highlevel_get_all_tasks`

List all tasks for a contact.

`contacts.readonly`

Get Task`highlevel_get_task`

Get a single contact task by id.

`contacts.readonly`

Create Contact Task`highlevel_create_contact_task`

Create a task on a contact.

`contacts.write`

Update Task`highlevel_update_task`

Update a contact task's title, body, due date, completion or assignee.

`contacts.write`

Update Task Completed`highlevel_update_task_completed`

Set the completed status of a contact task.

`contacts.write`

Delete Task`highlevel_delete_task`

Delete a task from a contact.

`contacts.write`

Get Appointments For Contact`highlevel_get_appointments_for_contact`

List appointments for a contact.

`contacts.readonly`

Get Duplicate Contact`highlevel_get_duplicate_contact`

Find an existing duplicate contact by email or phone in a location.

`contacts.readonly`

Lookup Contact By Email Or Phone`highlevel_lookup_contact_by_email_or_phone`

Look up contacts by exact email or phone in a location, up to 20 per page.

`contacts.readonly`

Search Contacts`highlevel_search_contacts`

Search contacts using combinations of advanced filters.

`contacts.readonly`

Get Contact`highlevel_get_contact`

Retrieve one contact by id.

`contacts.readonly`

Get Contacts By BusinessId`highlevel_get_contacts_by_businessid`

List contacts linked to a business.

`contacts.readonly`

Add Contact Followers`highlevel_add_contact_followers`

Add followers (users) to a contact.

`contacts.write`

Add Contact To Campaign`highlevel_add_contact_to_campaign`

Add a contact to a campaign.

`contacts.write`

Add Contact To Workflow`highlevel_add_contact_to_workflow`

Add a contact to a workflow, with an optional event start time.

`contacts.write`

Add Tags`highlevel_add_tags`

Add tags to one contact.

`contacts.write`

Add/Remove Contacts From Business`highlevel_addremove_contacts_from_business`

Bulk add or remove contacts from a business in a location.

Create Contact`highlevel_create_contact`

Create a new contact in a location.

`contacts.write`

Update Contacts Tags`highlevel_update_contacts_tags`

Add or remove tags across multiple contacts in one call.

Upsert Contact`highlevel_upsert_contact`

Create or update a contact following the location's Allow Duplicate Contact setting.

`contacts.write`

Update Contact`highlevel_update_contact`

Update an existing contact by id.

`contacts.write`

Delete Contact`highlevel_delete_contact`

Delete a contact by id.

`contacts.write`

Delete Contact From Workflow`highlevel_delete_contact_from_workflow`

Remove a contact from a workflow.

`contacts.write`

Remove Contact Followers`highlevel_remove_contact_followers`

Remove followers from a contact.

`contacts.write`

Remove Contact From Campaign`highlevel_remove_contact_from_campaign`

Remove a contact from one campaign.

`contacts.write`

Remove Contact From Every Campaign`highlevel_remove_contact_from_every_campaign`

Remove a contact from every campaign it is enrolled in.

`contacts.write`

Remove Tags`highlevel_remove_tags`

Remove tags from one contact.

`contacts.write`

Download Transcription By Message ID`highlevel_download_transcription_by_message_id`

Download the recording transcription for a message by passing the message id.

Export Messages By Location ID`highlevel_export_messages_by_location_id`

Export messages for a location with cursor-based pagination.

`conversations/message.readonly`

Get Messages By Conversation ID`highlevel_get_messages_by_conversation_id`

Get messages for a conversation.

`conversations/message.readonly`

Get Recording By Message ID`highlevel_get_recording_by_message_id`

Get the recording for a message by passing the message id.

Get Transcription By Message ID`highlevel_get_transcription_by_message_id`

Get the recording transcription for a message by passing the message id.

Get Email By ID`highlevel_get_email_by_id`

Get an email by id.

`conversations/message.readonly`

Get Message By Message ID`highlevel_get_message_by_message_id`

Get message by message id in HighLevel.

`conversations/message.readonly`

Add An External Outbound Call`highlevel_add_an_external_outbound_call`

Record an outbound call in a conversation via a conversation provider.

`conversations/message.write`

Add An Inbound Message`highlevel_add_an_inbound_message`

Record an inbound message in a conversation via a conversation provider.

`conversations/message.write`

Send A New Message`highlevel_send_a_new_message`

Send a new outbound message to a contact on a channel such as SMS or email.

`conversations/message.write`

Upload File Attachments`highlevel_upload_file_attachments`

Upload files as message attachments from URLs.

`conversations/message.write`

Update Message Status`highlevel_update_message_status`

Update the status of a message.

`conversations/message.write`

Cancel A Scheduled Email Message`highlevel_cancel_a_scheduled_email_message`

Cancel a scheduled email message.

`conversations/message.write`

Cancel A Scheduled Message`highlevel_cancel_a_scheduled_message`

Cancel a scheduled message.

`conversations/message.write`

Search Conversations`highlevel_search_conversations`

Search conversations by criteria with sort and filter options.

`conversations.readonly`

Get Conversation`highlevel_get_conversation`

Get the conversation details based on the conversation ID.

`conversations.readonly`

Create Conversation`highlevel_create_conversation`

Creates a new conversation with the data provided.

`conversations.write`

Update Conversation`highlevel_update_conversation`

Update the conversation details based on the conversation ID.

`conversations.write`

Delete Conversation`highlevel_delete_conversation`

Delete the conversation details based on the conversation ID.

`conversations.write`

Fetch Coupon`highlevel_fetch_coupon`

Retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code.

`payments/coupons.readonly`

List Coupons`highlevel_list_coupons`

Retrieve a list of all coupons available in your location.

`payments/coupons.readonly`

Create Coupon`highlevel_create_coupon`

Create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, and...

`payments/coupons.write`

Update Coupon`highlevel_update_coupon`

Modify existing coupon details such as discount values, validity periods, usage limits, and other promotional parameters...

`payments/coupons.write`

Delete Coupon`highlevel_delete_coupon`

Permanently remove a coupon from your system using its unique identifier.

`payments/coupons.write`

Get Custom Fields By Object Key`highlevel_get_custom_fields_by_object_key`

List custom fields for an object key in a location.

`locations/customFields.readonly`

Create Custom Field`highlevel_create_custom_field`

Create a custom field (Custom Objects and Company only today).

`locations/customFields.write`

Update Custom Field By ID`highlevel_update_custom_field_by_id`

Update a custom field by id.

`locations/customFields.write`

Delete Custom Field By ID`highlevel_delete_custom_field_by_id`

Delete a custom field by id.

`locations/customFields.write`

List Email Campaigns`highlevel_list_email_campaigns`

List email campaigns for a location.

`emails/campaigns.readonly`

Get Campaign Statistics`highlevel_get_campaign_statistics`

Get statistics for email campaigns, workflows or bulk actions by source and sourceId.

`emails/stats.readonly`

Get Email Campaign By ID`highlevel_get_email_campaign_by_id`

Get one email campaign by ID.

`emails/campaigns.readonly`

Create Email Campaign`highlevel_create_email_campaign`

Create a new email campaign in a location.

`emails/campaigns.write`

Update Email Campaign`highlevel_update_email_campaign`

Update an email campaign draft.

`emails/campaigns.write`

Schedule Campaign`highlevel_schedule_campaign`

Schedule or start an email campaign that is in draft, cancelled or paused status.

`emails/campaigns.write`

Delete Email Campaign`highlevel_delete_email_campaign`

Delete an email campaign.

`emails/campaigns.write`

List Email Templates`highlevel_list_email_templates`

List templates of a location, offset paginated with search and sortBy options.

`emails/templates.readonly`

Get Email Template By ID`highlevel_get_email_template_by_id`

Get one email template by templateId.

`emails/templates.readonly`

Create An Email Template`highlevel_create_an_email_template`

Create an email template in a location, needing name and editorType.

`emails/templates.write`

Update An Email Template`highlevel_update_an_email_template`

Update an email template by templateId.

`emails/templates.write`

Delete A Template`highlevel_delete_a_template`

Delete a template by templateId.

`emails/templates.write`

Get Forms`highlevel_get_forms`

List forms for a location.

`forms.readonly`

Get Forms Submissions`highlevel_get_forms_submissions`

List form submissions for a location.

`forms.readonly`

Get Unified Credentials`highlevel_unified_get_me`

Get the current HighLevel connection's unified credentials and identity.

`users.readonly`

List Unified Organizations`highlevel_unified_list_organizations`

List unified organizations (sub-accounts) in a HighLevel agency.

`locations.readonly`

Get Unified Organization`highlevel_unified_get_organization`

Get a unified HighLevel organization (sub-account) by ID.

`locations.readonly`

List Unified Roles`highlevel_unified_list_roles`

List unified roles in a HighLevel agency.

`users.readonly`

Get Unified Role`highlevel_unified_get_role`

Get a unified HighLevel role by ID.

`users.readonly`

List Unified Users`highlevel_unified_list_users`

List unified users in a HighLevel agency or sub-account.

`users.readonly`

Get Unified User`highlevel_unified_get_user`

Get a unified HighLevel user by ID.

`users.readonly`

Generate Estimate Number`highlevel_generate_estimate_number`

Get the next estimate number for the given location. Accepts Agency or Sub-Account tokens.

`invoices/estimate.readonly`

List Estimates`highlevel_list_estimates`

Get a paginated list of estimates using limit and offset. Accepts Agency or Sub-Account tokens.

`invoices/estimate.readonly`

Create Invoice From Estimate`highlevel_create_invoice_from_estimate`

Create a new invoice from an existing estimate. Accepts Agency or Sub-Account tokens.

`invoices/estimate.write`

Create New Estimate`highlevel_create_new_estimate`

Create a new estimate with the provided details. Accepts Agency or Sub-Account tokens.

`invoices/estimate.write`

Update Estimate`highlevel_update_estimate`

Update an existing estimate with new details. Accepts Agency or Sub-Account tokens.

`invoices/estimate.write`

Send Estimate`highlevel_send_estimate`

Send an estimate by estimateId. Accepts Agency or Sub-Account tokens.

`invoices/estimate.write`

Delete Estimate`highlevel_delete_estimate`

Delete an existing estimate. Accepts Agency or Sub-Account tokens.

`invoices/estimate.write`

List Schedules`highlevel_list_schedules`

List invoice schedules.

`invoices/schedule.readonly`

Get An Schedule`highlevel_get_an_schedule`

Get an invoice schedule by id.

`invoices/schedule.readonly`

Create Invoice Schedule`highlevel_create_invoice_schedule`

Create an invoice schedule.

`invoices/schedule.write`

Update Schedule`highlevel_update_schedule`

Update an invoice schedule by id.

`invoices/schedule.write`

Cancel An Scheduled Invoice`highlevel_cancel_an_scheduled_invoice`

Cancel a scheduled invoice by schedule id.

`invoices/schedule.write`

Schedule An Schedule Invoice`highlevel_schedule_an_schedule_invoice`

Start an invoice schedule so it begins sending to the customer.

`invoices/schedule.write`

Delete Schedule`highlevel_delete_schedule`

Delete an invoice schedule by id.

`invoices/schedule.write`

List Invoice Templates`highlevel_list_invoice_templates`

List invoice templates.

`invoices/template.readonly`

Get An Template`highlevel_get_an_template`

Get an invoice template by id.

`invoices/template.readonly`

Create Template`highlevel_create_template`

Create an invoice template.

`invoices/template.write`

Update Template`highlevel_update_template`

Update an invoice template by id.

`invoices/template.write`

Delete Template`highlevel_delete_template`

Delete an invoice template by id.

`invoices/template.write`

Generate Invoice Number`highlevel_generate_invoice_number`

Get the next invoice number for a location.

`invoices.readonly`

List Invoices`highlevel_list_invoices`

List invoices.

`invoices.readonly`

Get Invoice`highlevel_get_invoice`

Get an invoice by id.

`invoices.readonly`

Create Invoice`highlevel_create_invoice`

Create an invoice.

`invoices.write`

Create Send`highlevel_create_send`

Create or update a text2pay invoice.

`invoices.write`

Record A Manual Payment For An Invoice`highlevel_record_a_manual_payment_for_an_invoice`

Record a manual payment for an invoice.

`invoices.write`

Update Invoice`highlevel_update_invoice`

Update an invoice by id.

`invoices.write`

Send Invoice`highlevel_send_invoice`

Send an invoice to the customer.

`invoices.write`

Void Invoice`highlevel_void_invoice`

Void an invoice by id.

`invoices.write`

Delete Invoice`highlevel_delete_invoice`

Delete an invoice by id.

`invoices.write`

Get Custom Fields`highlevel_get_custom_fields`

List custom fields for a location.

`locations/customFields.readonly`

Get Custom Field`highlevel_get_custom_field`

Get one location custom field by id.

Create Location Custom Field`highlevel_create_location_custom_field`

Create a custom field for a location.

`locations/customFields.write`

Update Custom Field`highlevel_update_custom_field`

Update a location custom field.

Delete Custom Field`highlevel_delete_custom_field`

Delete a location custom field.

Get Custom Values`highlevel_get_custom_values`

Get all custom values for a location.

`locations/customValues.readonly`

Get Custom Value`highlevel_get_custom_value`

Get one custom value by id.

Create Custom Value`highlevel_create_custom_value`

Create a custom value in a location.

`locations/customValues.write`

Update Custom Value`highlevel_update_custom_value`

Update a custom value by id.

Delete Custom Value`highlevel_delete_custom_value`

Delete a custom value by id.

Get Tags`highlevel_get_tags`

List tags for a location.

`locations/tags.readonly`

Get Tag By ID`highlevel_get_tag_by_id`

Get one location tag by id.

Create Tag`highlevel_create_tag`

Create a tag in a location.

`locations/tags.write`

Update Tag`highlevel_update_tag`

Update a location tag name.

Delete Tag`highlevel_delete_tag`

Delete a location tag.

Task Search Filter`highlevel_task_search_filter`

Search tasks in a location with filters. Paginated by offset.

`locations/tasks.readonly`

Fetch Timezones`highlevel_fetch_timezones`

Fetch the available timezones for a location.

`locations.readonly`

Search Locations`highlevel_search_locations`

Search sub-accounts. Works with an Agency or Sub-Account token. Offset paginated using skip and limit.

`locations.readonly`

Get Sub-Account`highlevel_get_subaccount`

Get details of a sub-account by id. Works with an Agency or Sub-Account token.

`locations.readonly`

Create Sub-Account`highlevel_create_subaccount`

Create a new sub-account (formerly location) under the agency.

`locations.write`

Get List Of Filesfolders`highlevel_get_list_of_filesfolders`

Fetches list of files and folders from the media storage.

`medias.readonly`

Create Media Folder`highlevel_create_media_folder`

Creates a new folder in the media storage.

Upload File Into Media Storage`highlevel_upload_file_into_media_storage`

Upload a file to media storage, either by hosted file URL or by file content.

`medias.write`

Delete File Or Folder`highlevel_delete_file_or_folder`

Deletes specific file or folder from the media storage.

`medias.write`

Search Object Records`highlevel_search_object_records`

Search records of a custom object or business schema.

`objects/record.readonly`

Get Record By ID`highlevel_get_record_by_id`

Get a business or custom object record by id.

Create Record`highlevel_create_record`

Create a custom object or business record.

`objects/record.write`

Update Record`highlevel_update_record`

Update a custom object or business record by id.

Delete Record`highlevel_delete_record`

Delete a custom object or business record by id.

Get All Objects For A Location`highlevel_get_all_objects_for_a_location`

Get all objects for a location in HighLevel.

`objects/schema.readonly`

Get Object Schema By Key ID`highlevel_get_object_schema_by_key_id`

Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and prop...

`objects/schema.readonly`

Create Custom Object`highlevel_create_custom_object`

Create a custom object schema.

`objects/schema.write`

Update Object Schema By Key ID`highlevel_update_object_schema_by_key_id`

Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields.

`objects/schema.write`

Get Lost Reason`highlevel_get_lost_reason`

List lost reasons for a location, offset paginated, filterable by name, deleted and query.

`opportunities.readonly`

Search Opportunity`highlevel_search_opportunity`

Search opportunities by q, status, campaignId or id for a location, cursor paginated.

`opportunities.readonly`

Search Opportunities`highlevel_search_opportunities`

Search opportunities with advanced filter combinations, cursor paginated via searchAfter.

`opportunities.readonly`

Get Opportunity`highlevel_get_opportunity`

Get one opportunity by id.

`opportunities.readonly`

Add Opportunity Followers`highlevel_add_opportunity_followers`

Add followers to an opportunity by id.

`opportunities.write`

Create Opportunity`highlevel_create_opportunity`

Create an opportunity, needing pipelineId, locationId, name, status and contactId.

`opportunities.write`

Upsert Opportunity`highlevel_upsert_opportunity`

Create or update an opportunity, with pipelineId and locationId required, matched by contact and pipeline.

`opportunities.write`

Update Opportunity`highlevel_update_opportunity`

Update an opportunity by id.

`opportunities.write`

Update Opportunity Status`highlevel_update_opportunity_status`

Update only the status of an opportunity by id.

`opportunities.write`

Delete Opportunity`highlevel_delete_opportunity`

Delete an opportunity by id.

`opportunities.write`

Remove Opportunity Followers`highlevel_remove_opportunity_followers`

Remove specific followers, or all with isRemoveAllFollowers, from an opportunity.

`opportunities.write`

List Fulfillment`highlevel_list_fulfillment`

List the fulfillment history of an order.

`payments/orders.readonly`

List Order Notes`highlevel_list_order_notes`

List all notes of an order.

List Orders`highlevel_list_orders`

List orders with filters such as status, payment status and date range. Offset paginated.

`payments/orders.readonly`

Get Order By ID`highlevel_get_order_by_id`

Retrieve one order by orderId.

`payments/orders.readonly`

Create Order Fulfillment`highlevel_create_order_fulfillment`

Create a fulfillment for an order.

`payments/orders.write`

Record Order Payment`highlevel_record_order_payment`

Record a payment for an order and update its status.

`payments/orders.collectPayment`

Get Pipelines`highlevel_get_pipelines`

List pipelines for a location.

`opportunities.readonly`

Get Pipeline`highlevel_get_pipeline`

Retrieve one pipeline by id with its stages and configuration.

`pipelines.readonly`

Create Pipeline`highlevel_create_pipeline`

Create a pipeline with at least one stage for a location. Names must be unique per location.

`pipelines.create`

Update Pipeline`highlevel_update_pipeline`

Update a pipeline. The stages array is a full replacement. Include a stage id to keep it or omit it to create a new stag...

`pipelines.write`

Delete Pipeline`highlevel_delete_pipeline`

Permanently delete a pipeline and all opportunities within it. Irreversible.

`pipelines.write`

List Prices For A Product`highlevel_list_prices_for_a_product`

List prices of a product, offset paginated.

`products/prices.readonly`

Get Price By ID For A Product`highlevel_get_price_by_id_for_a_product`

Get one price of a product by priceId.

`products/prices.readonly`

Create Price For A Product`highlevel_create_price_for_a_product`

Create a price for a product.

`products/prices.write`

Update Price By ID For A Product`highlevel_update_price_by_id_for_a_product`

Update a price of a product by priceId.

`products/prices.write`

Delete Price By ID For A Product`highlevel_delete_price_by_id_for_a_product`

Delete a price of a product by priceId.

`products/prices.write`

List Products`highlevel_list_products`

List products of a location, offset paginated, filterable by search and collectionIds.

`products.readonly`

Get Product By ID`highlevel_get_product_by_id`

Get one product by productId and locationId.

`products.readonly`

Create Product`highlevel_create_product`

Create a product, needing name, locationId and productType. Works with an Agency or Sub-Account token.

`products.write`

Update Product By ID`highlevel_update_product_by_id`

Update a product by productId, needing name, locationId and productType.

`products.write`

Delete Product By ID`highlevel_delete_product_by_id`

Delete a product by productId and locationId.

`products.write`

Get Accounts`highlevel_get_accounts`

List social accounts and groups for a location.

`socialplanner/account.readonly`

Get Post`highlevel_get_post`

Get one social post by id.

`socialplanner/post.readonly`

Create Post`highlevel_create_post`

Create social posts for all supported platforms, with per-channel customization, needing locationId and type.

`socialplanner/post.write`

Get Posts`highlevel_get_posts`

List social planner posts for a location, offset paginated, with filters in the body.

`socialplanner/post.readonly`

Edit Post`highlevel_edit_post`

Edit a social post by id, needing locationId, id and type.

`socialplanner/post.write`

Delete Post`highlevel_delete_post`

Delete a social post by id.

`socialplanner/post.write`

List Subscriptions`highlevel_list_subscriptions`

List subscriptions with filters.

`payments/subscriptions.readonly`

Get Subscription By ID`highlevel_get_subscription_by_id`

Retrieve a subscription by id.

`payments/subscriptions.readonly`

Get Surveys`highlevel_get_surveys`

List surveys for a location, offset paginated with skip, limit and type.

`surveys.readonly`

Get Surveys Submissions`highlevel_get_surveys_submissions`

List survey submissions for a location, page number paginated, filterable by surveyId and q.

`surveys.readonly`

List Transactions`highlevel_list_transactions`

List transactions with filters such as payment mode and date range. Offset paginated.

`payments/transactions.readonly`

Get Transaction By ID`highlevel_get_transaction_by_id`

Retrieve one transaction by transactionId.

`payments/transactions.readonly`

Get Links`highlevel_get_links`

Get trigger links for a location.

`links.readonly`

Get Link By ID`highlevel_get_link_by_id`

Get a single trigger link by id.

`links.readonly`

Create Link`highlevel_create_link`

Create a trigger link.

`links.write`

Update Link`highlevel_update_link`

Update a trigger link.

`links.write`

Delete Link`highlevel_delete_link`

Delete a trigger link.

`links.write`

Search Users`highlevel_search_users`

Search Users in HighLevel.

`users.readonly`

Filter Users By Email`highlevel_filter_users_by_email`

Filter users by company ID, deleted status, and email array.

`users.readonly`

Get User`highlevel_get_user`

Get User in HighLevel.

`users.readonly`

Create User`highlevel_create_user`

Create User in HighLevel.

`users.write`

Update User`highlevel_update_user`

Update User in HighLevel.

`users.write`

Delete User`highlevel_delete_user`

Delete User in HighLevel.

`users.write`

Get Workflow`highlevel_get_workflow`

List workflows for a location.

`workflows.readonly`

Create Workflow`highlevel_create_workflow`

Create a draft workflow from a complete definition. Available only on sub-accounts where HighLevel has enabled the workf...

`workflows.write`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.