GET
/
visits
/
{id}
curl --request GET \
  --url https://api.axlehealth.com/api/v2-stable/visits/{id}
{
  "visit_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "summary_status": "UNSCHEDULED",
  "service_area_id": "a2b34371-99d2-4e7e-9d05-dc56e168b2aa",
  "address": {
    "line1": "123 Main St",
    "line2": "",
    "city": "Anytown",
    "state": "CA",
    "zip_code": "12345"
  },
  "clinic_id": null,
  "timezone": "America/Los_Angeles",
  "start_datetime": "2024-02-20T10:00:00",
  "duration_minutes": 60,
  "duration_override_minutes": null,
  "duration_computed_minutes": 60,
  "time_preferences": null,
  "priority": "STANDARD",
  "patient_appointments": [
    {
      "patient_id": "30b28dd9-fcb1-481c-b7b3-f3e5b6a6e3b2",
      "patient_confirmation_outcome": "NONE",
      "contact": {
        "first_name": "John",
        "last_name": "Doe",
        "phone": "+15555555555",
        "email": "john.doe@example.com"
      }
    }
  ],
  "clinician_appointments": [
    {
      "clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
      "name": "At-home Provider",
      "is_virtual": true,
      "start_offset_minutes": null,
      "duration_minutes": 60,
      "duration_override_minutes": null,
      "duration_computed_minutes": 60,
      "clinician_id": "bbde9f02-f44d-4ef0-924f-204674be2d62",
      "clinician_appointment_status": "NOT_STARTED"
    }
  ],
  "created_from_service_bundle_id": "30b28dd9-fcb1-481c-b7b3-f3e5b6a6e3b2",
  "encounters": [
    {
      "patient_id": "30b28dd9-fcb1-481c-b7b3-f3e5b6a6e3b2",
      "clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
      "encounter_outcome": "NONE",
      "encounter_outcome_notes": "Something unexpected happened. You should take a looks",
      "services": [
        {
          "service_id": "d0e8a28b-ebb2-4b3f-b934-890b1bc4e857",
          "service_completion_outcome": "NONE",
          "answers": [
            {
              "value": {
                "FakeAnswerKey": "FakeAnswerValue"
              },
              "question": {
                "question_id": "123e4567-e89b-12d3-a456-426614174000",
                "title": "Sample Question"
              }
            }
          ]
        }
      ]
    }
  ],
  "external_id": null,
  "metadata": {
    "foo": "bar"
  },
  "notes_for_clinicians": "",
  "notes_for_dashboard": "",
  "documents": []
}

Path Parameters

id
string
required

The unique identifier for the visit

Response

200 - application/json

Visit details retrieved successfully

The response is of type object.