POST
/
visit-time-options
/
potential-visit
curl --request POST \
  --url https://api.axlehealth.com/api/v2-stable/visit-time-options/potential-visit \
  --header 'Content-Type: application/json' \
  --data '{
  "search_window": {
    "start_datetime": "2024-01-01T01:00:00Z",
    "end_datetime": "2024-03-01T01:00:00Z"
  },
  "potential_visit": {
    "service_area_id": "a2b34371-99d2-4e7e-9d05-dc56e168b2aa",
    "address": {
      "line1": "123 Main St",
      "line2": "",
      "city": "Anytown",
      "state": "CA",
      "zip_code": "12345"
    },
    "clinic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "duration_override_minutes": 60,
    "clinician_appointments": [
      {
        "clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
        "is_virtual": true,
        "start_offset_minutes": 123,
        "duration_override_minutes": 123
      }
    ],
    "encounters": [
      {
        "clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
        "patient_id": "e4c5371b-d421-4e41-aedc-9294fcd6323b",
        "services": [
          {
            "service_id": "d0e8a28b-ebb2-4b3f-b934-890b1bc4e857"
          }
        ]
      }
    ]
  },
  "clinician_filters": [
    {
      "clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
      "clinicians": [
        {
          "clinician_id": "bfa23251-4e6e-4ddb-9096-171750871787"
        }
      ]
    }
  ]
}'
{
  "recommended_time_options": [
    {
      "start_datetime": "2024-08-27T13:45:00-05:00",
      "end_datetime": "2024-08-27T14:00:00-05:00"
    }
  ]
}

Body

application/json

Response

200
application/json

Successful response with recommended time options

The response is of type object.