Get Free Slots
highlevel.get_free_slots
ActionCRM & salesconnection required
Calls the HighLevel API with the connection's credentials.
List the bookable times on a calendar between two dates.
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
5 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
calendar_id The calendar id, from highlevel.list_calendars. | string | Yes | — | — | — |
start_date Window start, in epoch milliseconds. | number | Yes | — | ≥ 0 | — |
end_date Window end, in epoch milliseconds. HighLevel refuses a range longer than 31 days. | number | Yes | — | ≥ 0 | — |
timezone IANA timezone the slots are returned in, e.g. America/Chicago. | string | No | — | — | — |
user_id Only this user's availability on the calendar. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
by_date HighLevel's map of YYYY-MM-DD to that day's slots. | object | — |
slots Every slot time, flattened in date order. | array | — |
count How many slots are in slots. | number | — |
calendar_id The calendar that was read. | string | — |
{
"by_date": {},
"calendar_id": "",
"count": 0,
"slots": []
}See Get Free Slots 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.