Query Realtime Appointment Availability | Propexo

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

{
  "meta": {
    "job_id": "job-9876543210"
  },
  "result": [
    {
      "last_seen": "2024-06-10T14:00:00Z",
      "calendar_type": "AGENT_CALENDAR",
      "x_agent_id": "agent-4567",
      "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-12",
          "day_of_week": "Wednesday",
          "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_community_id": "community-7890"
    }
  ]
}

Query Realtime Appointment Availability

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

integration_idstringRequired

community_idstringOptional

The Propexo unique identifier for the community

appointment_typeenumOptional

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

Allowed values:

start_datestringOptional

The start of the date range to check for availability on. This defaults to the current day.

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