Search
K
Viewing Appointments

AppointmentType

string

Allowed values:individualgroupvirtual

Example

AppointmentInput

object
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.

Example

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

Example

Confirmation

object
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

Example

TimeSlot

object
startstring(date-time)

Example:2026-09-03T16:00:00+02:00

endstring(date-time)

Example:2026-09-03T16:30:00+02:00

bookableboolean

Example:true

Example