Appointments

Query Realtime Appointment Availability

Query Realtime Appointment Availability

post/crm/v1/appointment-availability

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/crm/v1/appointment-availability
  • Auth: HTTP bearer

Request body

integration_idstring required
community_idstring

The Propexo unique identifier for the community

start_timestring date-time

The start of the time range to check for availability. This time should be specified in UTC.

end_timestring date-time

The end of the time range to check for availability. This time should be specified in UTC.

tour_type'IN_PERSON' | 'SELF_GUIDED' | 'LIVE_VIDEO'

The type of tour to query availability for. If omitted, availability for all tour types will be returned as separate calendars distinguished by tour_type.

appointment_type'SELF_GUIDED_TOUR' | 'APPOINTMENT'

The kind of appointment calendar to query for realtime availability from Knock

days_to_queryinteger

The number of days (including the start_date) to query appointment availability for. Defaults to 2 days. Properties can configure a max that may be lower than what you request. In this case, the max for the property will be used.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.