Get schedule - Automate.ax

highlevel.getSchedule retrieves one availability schedule by ID.

automations/highlevel-get-schedule.automation.ts

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

export default automation("Get schedule", () => {
  markSignificant(
    highlevel.getSchedule({
      id: "IkqiJlXJ7o9h61tCHHod",
    }),
  )
})

Input

Field	Type	Required	Description
`id`	`string`	Yes	HighLevel id value.

Automate.ax supplies the connected sub-account’s location ID. Optional second argument { account } selects a named HighLevel binding.

Output

Field	Type	Required	Description
`schedule`	`JSON value`	Yes	Schedule

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