HighLevel

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

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

Get a SYSTEM_DEFINED or USER_DEFINED association by id.

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

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

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

Create a relation linking two records under an existing association.

Update the labels of an association.

Delete a USER_DEFINED association by id.

Delete a relation by relationId.

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

Retrieve one business by businessId.

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

Update a business by businessId.

Delete a business by businessId.

List blocked slots for a location within a time range.

List calendar events for a location within a time range.

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

Fetch one appointment by eventId.

Book a new appointment on a calendar for a contact.

Add a note to an existing appointment.

Create a blocked time slot on a calendar.

Update an existing appointment by eventId.

Update the body of an existing appointment note.

Update a blocked slot by eventId.

Delete a note from an appointment by appointmentId and noteId.

Delete a calendar event by eventId.

List all calendar groups in a location.

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

Enable or disable a calendar group via isActive.

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

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

Delete a calendar group by groupId.

List notifications for a calendar based on query.

Get one calendar notification by notificationId.

Create one or more notifications for a single calendar.

Update a calendar notification by id.

Delete a calendar notification by id.

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

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

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

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

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

List all calendars in a location.

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

Get a calendar by ID.

Create a calendar in a location.

Update a calendar by ID.

Delete a calendar by ID.

Get campaigns for a location.

Get a company by companyId. Requires an Agency token.

List all notes for a contact.

Fetch one contact note by contactId and note id.

Create a note on a contact.

Update an existing contact note by contactId and note id.

Delete a contact note by contactId and note id.

List all tasks for a contact.

Get a single contact task by id.

Create a task on a contact.

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

Set the completed status of a contact task.

Delete a task from a contact.

List appointments for a contact.

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

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

Search contacts using combinations of advanced filters.

Retrieve one contact by id.

List contacts linked to a business.

Add followers (users) to a contact.

Add a contact to a campaign.

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

Add tags to one contact.

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

Create a new contact in a location.

Add or remove tags across multiple contacts in one call.

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

Update an existing contact by id.

Delete a contact by id.

Remove a contact from a workflow.

Remove followers from a contact.

Remove a contact from one campaign.

Remove a contact from every campaign it is enrolled in.

Remove tags from one contact.

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

Export messages for a location with cursor-based pagination.

Get messages for a conversation.

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

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

Get an email by id.

Get message by message id in HighLevel.

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

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

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

Upload files as message attachments from URLs.

Update the status of a message.

Cancel a scheduled email message.

Cancel a scheduled message.

Search conversations by criteria with sort and filter options.

Get the conversation details based on the conversation ID.

Creates a new conversation with the data provided.

Update the conversation details based on the conversation ID.

Delete the conversation details based on the conversation ID.

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

Retrieve a list of all coupons available in your location.

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

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

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

List custom fields for an object key in a location.

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

Update a custom field by id.

Delete a custom field by id.

List email campaigns for a location.

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

Get one email campaign by ID.

Create a new email campaign in a location.

Update an email campaign draft.

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

Delete an email campaign.

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

Get one email template by templateId.

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

Update an email template by templateId.

Delete a template by templateId.

List forms for a location.

List form submissions for a location.

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

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

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

List unified roles in a HighLevel agency.

Get a unified HighLevel role by ID.

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

Get a unified HighLevel user by ID.

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

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

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

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

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

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

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

List invoice schedules.

Get an invoice schedule by id.

Create an invoice schedule.

Update an invoice schedule by id.

Cancel a scheduled invoice by schedule id.

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

Delete an invoice schedule by id.

List invoice templates.

Get an invoice template by id.

Create an invoice template.

Update an invoice template by id.

Delete an invoice template by id.

Get the next invoice number for a location.

List invoices.

Get an invoice by id.

Create an invoice.

Create or update a text2pay invoice.

Record a manual payment for an invoice.

Update an invoice by id.

Send an invoice to the customer.

Void an invoice by id.

Delete an invoice by id.

List custom fields for a location.

Get one location custom field by id.

Create a custom field for a location.

Update a location custom field.

Delete a location custom field.

Get all custom values for a location.

Get one custom value by id.

Create a custom value in a location.

Update a custom value by id.

Delete a custom value by id.

List tags for a location.

Get one location tag by id.

Create a tag in a location.

Update a location tag name.

Delete a location tag.

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

Fetch the available timezones for a location.

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

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

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

Fetches list of files and folders from the media storage.

Creates a new folder in the media storage.

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

Deletes specific file or folder from the media storage.

Search records of a custom object or business schema.

Get a business or custom object record by id.

Create a custom object or business record.

Update a custom object or business record by id.

Delete a custom object or business record by id.

Get all objects for a location in HighLevel.

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

Create a custom object schema.

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

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

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

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

Get one opportunity by id.

Add followers to an opportunity by id.

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

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

Update an opportunity by id.

Update only the status of an opportunity by id.

Delete an opportunity by id.

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

List the fulfillment history of an order.

List all notes of an order.

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

Retrieve one order by orderId.

Create a fulfillment for an order.

Record a payment for an order and update its status.

List pipelines for a location.

Retrieve one pipeline by id with its stages and configuration.

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

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…

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

List prices of a product, offset paginated.

Get one price of a product by priceId.

Create a price for a product.

Update a price of a product by priceId.

Delete a price of a product by priceId.

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

Get one product by productId and locationId.

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

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

Delete a product by productId and locationId.

List social accounts and groups for a location.

Get one social post by id.

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

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

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

Delete a social post by id.

List subscriptions with filters.

Retrieve a subscription by id.

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

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

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

Retrieve one transaction by transactionId.

Get trigger links for a location.

Get a single trigger link by id.

Create a trigger link.

Update a trigger link.

Delete a trigger link.

Search Users in HighLevel.

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

Get User in HighLevel.

Create User in HighLevel.

Update User in HighLevel.

Delete User in HighLevel.

List workflows for a location.

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