Query Realtime Appointment Availability

POST
/v1/appointment-availability/

Query Realtime Appointment Availability

Request

This endpoint expects an object.
integration_idstringRequired
property_idstringOptional

The Propexo unique identifier for the property

availability_start_datedatetime or stringOptional

The start date of the availability to query. RealPage Partner Exchange will return results starting at midnight of this date in the local timezone of the property.

availability_duration_daysintegerOptional

The duration of the availability query, in days

appointment_duration_minutesintegerOptionalDefaults to 30

The duration of the appointment, in minutes. RealPage Partner Exchange does not provide a default appointment duration. A value of 30 minutes is assumed if this field is not provided.

calendar_typeslist of enumsOptional
Allowed values: GENERALRESIDENTLEASINGMAINTENANCE

The calendar groups to consider when evaluating what availability is possible, defaulting to the Resident and Leasing calendar groups if not provided. Note that Entrata only supports API creation of appointment types for the Leasing group at this time.

employee_idstringOptional

The Propexo unique identifier for the employee. The API will only return availability for this employee. If not provided, availability will be returned for all employees.

Response

This endpoint returns an object.
metaobject
resultlist of optional objects

Errors