# List Appointments

Retrieves a list of all appointments.

Endpoint: GET /v2/appointments
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Query parameters:

  - `page_index` (string)

  - `page_size` (string)

  - `order_by` (string)
    Enum: "patient_id", "patient_first_name", "patient_last_name", "patient_full_name", "practitioner_first_name", "practitioner_last_name", "practitioner_full_name", "appointment_template_name", "appointment_source", "location_name", "confirmed_at", "start_time"

  - `order_descending` (boolean)

  - `patient_id` (string)

  - `patient_first_name` (string)

  - `patient_last_name` (string)

  - `patient_full_name` (string)

  - `practitioner_first_name` (string)

  - `practitioner_last_name` (string)

  - `practitioner_full_name` (string)

  - `appointment_template_name` (string)

  - `location_name` (string)

  - `has_been_cancelled` (boolean)

  - `appointment_source` (string)
    Enum: "Hero patient led", "Hero admin led", "Hero booking link", "Hero booking API", "EMIS", "Cliniko"

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.patient` (object,null)

  - `data.patient.title` (string,null)
    Enum: "Baron", "Baroness", "Brigadier", "Count", "Colonel", "Countess", "Captain", "Dame", "The Dowager Viscountess", "Dr", "Duchess", "Duke", "Earl", "His Excellency", "Father", "H.E. Ambassador Mr", "H.E. Mr", "H.E. Mrs", "Her Grace", "His Grace", "The Hon", "The Hon Mr", "The Hon Mrs", "HRH", "HRH Prince", "HRH Princess", "Insurance", "HM King", "Lady", "Lord", "Major", "Master", "Miss", "Mr", "Mrs", "Ms", "Mss", "Mx", "Pr", "Professor", "HM Queen", "Rabbi", "Reverend", "Sheikh", "Sheikha", "Sir", "The", "", "Viscount", "Viscountess"

  - `data.patient.first_name` (string,null)

  - `data.patient.last_name` (string,null)

  - `data.practitioner` (object,null)

  - `data.location_id` (string, required)

  - `data.start_time` (string,null, required)

  - `data.reserved_until` (string,null)

  - `data.booking_confirmed_at` (string,null)

  - `data.can_be_cancelled` (boolean)

  - `data.can_be_rescheduled` (boolean)

  - `data.cancellation_policy_hours` (number)

  - `data.appointment_template_name` (string,null)

  - `data.cancelled_at` (string,null)

  - `data.confirmed_at` (string,null)

  - `data.appointment_source` (string,null)

  - `data.video` (boolean,null)

  - `data.in_person` (boolean)

  - `data.telephone` (boolean)

  - `data.location_name` (string,null)

  - `data.service` (string,null)

  - `data.source` (string,null)

  - `data.status` (string,null)

  - `data.appointment_type_id` (string,null)

  - `data.duration` (number,null)

  - `data.patient_uid` (string,null)

  - `data.practitioner_id` (string,null)

  - `count` (number, required)

## Response 400 fields (application/json):

  - `error` (boolean, required)

  - `statusCode` (number, required)

  - `message` (array, required)

  - `message.code` (string, required)

  - `message.expected` (string, required)

  - `message.path` (array, required)


## Response 401 fields

## Response 404 fields

## Response 500 fields