Query Realtime Appointment Availability: RealPage Partner Exchange | Propexo

import requests
url = "https://api.propexo.com/v1/appointment-availability/realpage_rpx/"
payload = {
    "integration_id": "string",
    "property_id": "string",
    "availability_start_date": "2024-01-15T09:30:00Z",
    "availability_duration_days": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "meta": {
    "job_id": "string"
  },
  "result": [
    {
      "last_seen": "string",
      "calendar_type": "AGENT_CALENDAR",
      "x_agent_id": "string",
      "agent_first_name": "string",
      "agent_last_name": "string",
      "default_appointment_length": 1.1,
      "minimum_appointment_lead_time": 1.1,
      "timezone": "string",
      "calendar_days": [
        {
          "date": "2024-01-15T09:30:00Z",
          "day_of_week": "string",
          "opening_time": "string",
          "closing_time": "string",
          "simultaneous_appointment_mode": "SINGLE",
          "max_simultaneous_appointments": 1.1,
          "available_slots": [
            {
              "start": "string",
              "end": "string"
            }
          ]
        }
      ],
      "x_property_id": "string"
    }
  ]
}

Query Realtime Appointment Availability: RealPage Partner Exchange

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. RealPage Partner Exchange will return results starting at midnight of this date in the local timezone of the property.

availability_duration_daysintegerRequired1-7

The duration of the availability query, in days

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.

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.

Response

Successful response

metaobject

resultlist of objects

Authentication

Request

Response

Errors