List Calendar Events

highlevel.list_calendar_events
ActionCRM & salesconnection required

Calls the HighLevel API with the connection's credentials.

List booked appointments in a time window.

Connection

Required
Yes — the node will not save without one
Auth type
OAuth 2.0
Providers
HighLevel
Secret shape
{"client_id": "…", "client_secret": "…", "refresh_token": "…"} for a marketplace app, or {"access_token": "…"} for a Private Integration Token
Config it needs
location_id, user_type, base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

6 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
start_time
Window start, in epoch milliseconds — HighLevel's own units for this parameter.
stringYes———
end_time
Window end, in epoch milliseconds.
stringYes———
calendar_id
Only this calendar's appointments.
stringNo———
user_id
Only this user's appointments.
stringNo———
group_id
Only this calendar group's appointments.
stringNo———
location_id
Sub-account (location) id to act on instead of the connection's own.
stringNo———
  • At least one of calendar_id, user_id, group_id must be set.

Output

One shape.

result

FieldTypeExample
items
One entry per row HighLevel returned.
array—
count
How many rows are in items.
number—
{
  "count": 0,
  "items": []
}

Notes

  • Scoped to the connection's location_id (the sub-account) unless the node overrides it.
  • HighLevel requires one of calendar_id, user_id or group_id alongside the window.

See List Calendar Events run in a workflow.

In a technical demo we add the HighLevel connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.