appointmentIdstringrequired
Example:appt_9a44
Retrieve an appointment
get
Path Parameters
Response
application/json
Response
application/json
Appointment
Appointment
property_idstringrequired
Example:prop_8f2c1a
typestringrequired
Allowed values:individualgroupvirtual
Example:individual
startstring(date-time)required
Example:2026-09-03T16:00:00+02:00
duration_minutesinteger
Default:30
>= 10<= 240
slotsinteger
Only evaluated when type: group.
>= 1
Example:12
meeting_pointstring
<= 200 characters
Example:In front of the main entrance, 148 Elm Street
notestring
<= 500 characters
Example:Please bring photo ID; the unit is currently occupied.
idstring
Example:appt_9a44
statusstring
Allowed values:scheduledconfirmedcompletedcancelled
Example:confirmed
confirmations_countinteger
Example:8
waitlist_countinteger
Example:2
created_atstring(date-time)
Example:2026-08-20T11:02:10Z
get/appointments/{appointmentId}
Authentication
Path Parameters
application/json
Reschedule or update an appointment
When the start time changes, all confirmed attendees are notified automatically.
patch
Path Parameters
appointmentIdstringrequired
Example:appt_9a44
Body
application/json
Body
application/json
AppointmentInput
property_idstringrequired
Example:prop_8f2c1a
typestringrequired
Allowed values:individualgroupvirtual
Example:individual
startstring(date-time)required
Example:2026-09-03T16:00:00+02:00
duration_minutesinteger
Default:30
>= 10<= 240
slotsinteger
Only evaluated when type: group.
>= 1
Example:12
meeting_pointstring
<= 200 characters
Example:In front of the main entrance, 148 Elm Street
notestring
<= 500 characters
Example:Please bring photo ID; the unit is currently occupied.
Response
application/json
Response
application/json
Updated
Appointment
property_idstringrequired
Example:prop_8f2c1a
typestringrequired
Allowed values:individualgroupvirtual
Example:individual
startstring(date-time)required
Example:2026-09-03T16:00:00+02:00
duration_minutesinteger
Default:30
>= 10<= 240
slotsinteger
Only evaluated when type: group.
>= 1
Example:12
meeting_pointstring
<= 200 characters
Example:In front of the main entrance, 148 Elm Street
notestring
<= 500 characters
Example:Please bring photo ID; the unit is currently occupied.
idstring
Example:appt_9a44
statusstring
Allowed values:scheduledconfirmedcompletedcancelled
Example:confirmed
confirmations_countinteger
Example:8
waitlist_countinteger
Example:2
created_atstring(date-time)
Example:2026-08-20T11:02:10Z
patch/appointments/{appointmentId}
Authentication
Path Parameters
Body
{
"start": "2026-09-03T17:30:00+02:00"
}
application/json
Cancel an appointment
delete
Path Parameters
appointmentIdstringrequired
Example:appt_9a44
Response
Response
Cancelled; attendees have been notified
delete/appointments/{appointmentId}
Authentication
Path Parameters
List confirmations for an appointment
get
Path Parameters
appointmentIdstringrequired
Example:appt_9a44
Response
200 application/json
Response
200 application/json
Attendee list
dataarray[object]
Show Child Parameters
open_slotsinteger
Example:4
get/appointments/{appointmentId}/confirmations
Authentication
Path Parameters
200 application/json
Confirm a lead's attendance
If the appointment is fully booked, the lead is placed on the waitlist instead.
post
Path Parameters
appointmentIdstringrequired
Example:appt_9a44
Body
application/json
Body
application/json
lead_idstringrequired
Example:lead_71ab
guestsinteger
Default:0
>= 0<= 3
Response
application/json
Response
application/json
Confirmation recorded
Confirmation
idstring
Example:conf_1f7c
appointment_idstring
Example:appt_9a44
lead_idstring
Example:lead_71ab
statestring
Allowed values:confirmedwaitlistedcancelledattendedno_show
guestsinteger
Example:1
confirmed_atstring(date-time)
Example:2026-08-21T09:14:00Z
post/appointments/{appointmentId}/confirmations
Authentication
Path Parameters
Body
{
"lead_id": "lead_71ab"
}
application/json