Search
K
Viewing Appointments

Create an appointment

post

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

Created

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

post/appointments

Body

{ "property_id": "prop_8f2c1a", "type": "individual", "start": "2026-09-03T16:00:00+02:00", "duration_minutes": 30, "meeting_point": "In front of the main entrance, 148 Elm Street" }
 
application/json

Retrieve an appointment

get

Path Parameters

appointmentIdstringrequired

Example:appt_9a44

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}
 
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

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

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}

Body

{ "start": "2026-09-03T17:30:00+02:00" }
 
application/json

Cancel an appointment

delete

Path Parameters

appointmentIdstringrequired

Example:appt_9a44

Response

Cancelled; attendees have been notified

delete/appointments/{appointmentId}
 

List confirmations for an appointment

get

Path Parameters

appointmentIdstringrequired

Example:appt_9a44

Response

200 application/json

Attendee list

dataarray[object]
Show Child Parameters
open_slotsinteger

Example:4

get/appointments/{appointmentId}/confirmations
 
200 application/json