Query Realtime Appointment Availability: Entrata | Propexo

curl -X POST https://api.propexo.com/v1/appointment-availability/entrata/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg_987654321",
  "property_id": "prop_123456789",
  "availability_start_date": "2024-01-15",
  "availability_duration_days": 3
}'

{
  "meta": {
    "job_id": "job_20240115_001"
  },
  "result": [
    {
      "last_seen": "2024-01-14T22:00:00-07:00",
      "calendar_type": "AGENT_CALENDAR",
      "x_agent_id": "agent_456",
      "agent_first_name": "Emily",
      "agent_last_name": "Johnson",
      "default_appointment_length": 30,
      "minimum_appointment_lead_time": 60,
      "timezone": "America/Denver",
      "calendar_days": [
        {
          "date": "2024-01-15",
          "day_of_week": "Monday",
          "opening_time": "09:00:00",
          "closing_time": "17:00:00",
          "simultaneous_appointment_mode": "SINGLE",
          "max_simultaneous_appointments": 1,
          "available_slots": [
            {
              "start": "09:00:00",
              "end": "09:30:00"
            },
            {
              "start": "10:00:00",
              "end": "10:30:00"
            },
            {
              "start": "14:00:00",
              "end": "14:30:00"
            }
          ]
        }
      ],
      "x_property_id": "ext_prop_123"
    }
  ]
}

Query Realtime Appointment Availability: Entrata

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

property_idstringRequired

The Propexo unique identifier for the property

availability_start_datestringRequired

The start date of the availability to query. Entrata will return results starting at midnight of this date in Mountain Time which respects daylight savings time.

availability_duration_daysintegerRequired1-7

The duration of the availability query, in days

appointment_duration_minutesintegerOptional

The duration of the appointment, in minutes. Slot availability calculations will be performed using the default appointment duration for each calendar if not provided.

calendar_typeslist of enumsOptional

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.

Allowed values:

Response

Successful response

metaobject

resultlist of objects

Errors

400

Bad Request Error