High Level

Node: highLevel · Full type: n8n-nodes-base.highLevel · Version: 2

Credentials

highLevelOAuth2Api (alias: @high)

CREDENTIAL @high = highLevelOAuth2Api "My High Level"

Operations

Resource: contact

create

Parameter	Type	Default	Details
email	string	""
phone	string	""
additionalFields	collection	{}	keys: address1, city, customFields, dnd, firstName, lastName, ...

delete

Parameter	Type	Default	Details
contactId	string	""	required

get

Parameter	Type	Default	Details
contactId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50
filters	collection	{}	keys: query
options	collection	{}	keys: order, sortBy

update

Parameter	Type	Default	Details
contactId	string	""	required
updateFields	collection	{}	keys: address1, city, customFields, dnd, email, firstName, ...

Resource: opportunity

create

Parameter	Type	Default	Details
pipelineId	options	""
contactId	options	""	required
name	string	""	required
status	options	"open"	required; open, won, lost, abandoned
additionalFields	collection	{}	keys: assignedTo, companyName, monetaryValue, tags, stageId

delete

Parameter	Type	Default	Details
opportunityId	string	""	required

get

Parameter	Type	Default	Details
opportunityId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	20
filters	collection	{}	keys: assignedTo, campaignId, endDate, pipelineId, stageId, startDate, ...

update

Parameter	Type	Default	Details
opportunityId	string	""	required
updateFields	collection	{}	keys: assignedTo, monetaryValue, name, pipelineId, stageId, status

Resource: task

create

Parameter	Type	Default	Details
contactId	options	""	required
title	string	""	required
dueDate	dateTime	""	required
completed	boolean	false	required
additionalFields	collection	{}	keys: assignedTo, body

delete

Parameter	Type	Default	Details
contactId	options	""	required
taskId	string	""	required

get

Parameter	Type	Default	Details
contactId	options	""	required
taskId	string	""	required

getAll

Parameter	Type	Default	Details
contactId	options	""	required
returnAll	boolean	false
limit	number	20

update

Parameter	Type	Default	Details
contactId	options	""	required
taskId	string	""	required
updateFields	collection	{}	keys: assignedTo, completed, body, dueDate, title

Resource: calendar

bookAppointment

Parameter	Type	Default	Details
calendarId	string	""	required
locationId	string	""	required
contactId	string	""	required
startTime	string	""	required
additionalFields	collection	{}	keys: endTime, title, appointmentStatus, assignedUserId, address, ignoreDateRange, ...

getFreeSlots

Parameter	Type	Default	Details
calendarId	string	""	required
startDate	number	""	required
endDate	number	""	required
additionalFields	collection	{}	keys: timezone, userId, userIds, enableLookBusy

Common Parameters

Parameter	Type	Default	Details
requestOptions	collection	{}	keys: batching, allowUnauthorizedCerts, proxy, timeout

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
address1	string	""
city	string	""
customFields	fixedCollection	{}	groups: values
dnd	boolean	false
firstName	string	""
lastName	string	""
name	string	"e.g. John Deo"
postalCode	string	""
source	string	""
state	string	""
notes	string	""
tags	string	""
timezone	resourceLocator	""	modes: list, id
website	string	""

updateFields children:

Parameter	Type	Default	Details
address1	string	""
city	string	""
customFields	fixedCollection	{}	groups: values
dnd	boolean	false
email	string	""
firstName	string	""
lastName	string	""
name	string	"e.g. John Deo"
phone	string	""
postalCode	string	""
state	string	""
tags	string	""
timezone	resourceLocator	""	modes: list, id
website	string	""

filters children:

Parameter	Type	Default	Details
query	string	""

options children:

Parameter	Type	Default	Details
order	options	"desc"	desc, asc
sortBy	options	"date_added"	date_added, date_updated

requestOptions children:

Parameter	Type	Default	Details
batching	fixedCollection	{...}	groups: batch
allowUnauthorizedCerts	boolean	false
proxy	string	""
timeout	number	10000

Example

NODE "highLevel" @high AS "High Level" {
  resource: "contact",
  operation: "get",
  contactId: {{ $json.contactId }},
  name: {{ $json.name }},
  opportunityId: {{ $json.opportunityId }}
}