Get Appointment
highlevel.get_appointment
ActionCRM & salesconnection required
Calls the HighLevel API with the connection's credentials.
Read one appointment by its event id.
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
1 field, 1 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 |
|---|---|---|---|---|---|
event_id The appointment (event) id. For one occurrence of a recurring appointment pass the instance id; for the whole series pass the masterEventId. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The appointment (event) id. | string | — |
calendarId The calendar it was booked on. | string | — |
locationId The sub-account it belongs to. | string | — |
contactId The contact it was booked for. | string | — |
startTime Start of the appointment (ISO-8601). | string | — |
endTime End of the appointment (ISO-8601). | string | — |
title Appointment title. | string | — |
appointmentStatus new, confirmed, cancelled, showed, noshow or invalid. | string | — |
assignedUserId User the appointment is assigned to. | string | — |
address Where it happens, or the meeting link. | string | — |
{
"address": "",
"appointmentStatus": "",
"assignedUserId": "",
"calendarId": "",
"contactId": "",
"endTime": "",
"id": "",
"locationId": "",
"startTime": "",
"title": ""
}See Get Appointment 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.