Query Realtime Appointment Availability: Rentcafe | Propexo

curl -X POST https://api.propexo.com/crm/v1/appointment-availability/rentcafe/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
  "community_id": "comm_1234567890abcdef"
}'

{
  "meta": {
    "job_id": "job_20240615_abcdef123456"
  },
  "result": [
    {
      "last_seen": "2024-06-14T18:45:00Z",
      "calendar_type": "AGENT_CALENDAR",
      "x_agent_id": "agent_9876543210fedcba",
      "agent_first_name": "Emily",
      "agent_last_name": "Johnson",
      "default_appointment_length": 30,
      "minimum_appointment_lead_time": 60,
      "timezone": "America/New_York",
      "calendar_days": [
        {
          "date": "2024-06-15",
          "day_of_week": "Saturday",
          "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"
            }
          ]
        },
        {
          "date": "2024-06-16",
          "day_of_week": "Sunday",
          "opening_time": "10:00:00",
          "closing_time": "16:00:00",
          "simultaneous_appointment_mode": "SINGLE",
          "max_simultaneous_appointments": 1,
          "available_slots": [
            {
              "start": "10:00:00",
              "end": "10:30:00"
            },
            {
              "start": "11:30:00",
              "end": "12:00:00"
            }
          ]
        }
      ],
      "x_community_id": "comm_1234567890abcdef"
    }
  ]
}

Query Realtime Appointment Availability. If no data has changed since your last request, you will receive a 304 response from RentCafe. To observe changes, please implement data caching on your side.

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

community_idstringRequired

The Propexo unique identifier for the community

days_to_queryintegerOptional1-30Defaults to 2

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

metaobject

resultlist of objects

Errors

400

Bad Request Error