List appointments - Automate.ax

highlevel.listAppointments lists calendar events and appointments in a date range.

automations/highlevel-list-appointments.automation.ts

import { automation, markSignificant } from "automate.ax"
import { highlevel } from "automate.ax/highlevel"

export default automation("List appointments", () => {
  markSignificant(
    highlevel.listAppointments({
      calendarId: "BqTwX8QFwXzpegMve9EQ",
      startTime: "1680373800000",
      endTime: "1680978599999",
    }),
  )
})

Input

Field	Type	Required	Description
`userId`	`string`	No	HighLevel user id value.
`calendarId`	`string`	No	HighLevel calendar id value.
`groupId`	`string`	No	HighLevel group id value.
`startTime`	`string`	Yes	HighLevel start time value.
`endTime`	`string`	Yes	HighLevel end time value.

Automate.ax supplies the connected sub-account’s location ID. Optional second argument { account } selects a named HighLevel binding. Provide at least one selector: calendarId, groupId, or userId.

Output

Field	Type	Required	Description
`events`	`object[]`	No	HighLevel events value.

This action calls GET /calendars/events with HighLevel API version 2021-04-15 and requires calendars/events.readonly. HighLevel validation and permission errors fail the action. Rate limits honor the provider’s retry timing.