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
Availability
Query open time slots
Returns bookable slots for a property, derived from the responsible
agent’s stored working hours minus appointments already booked.
get
Query Parameters
property_idstringrequired
Example:prop_8f2c1a
fromstring(date)required
tostring(date)required
Response
200 application/json
Response
200 application/json
Time slots
dataarray[object]
Show Child Parameters
get/availability
Authentication
Query Parameters
200 application/json