List Appointments

Retrieves a list of all appointments.

SecurityapiKeyAuth and practiceGroupId

Request

query Parameters

page_index	string
page_size	string
order_by	string Enum: "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_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"

Responses

200

400

Validation error

401

Unauthorised

404

Not found

500

Unknown error

get/v2/appointments

Request samples

curl
Node.js
Ruby

Response samples

application/json

{"data": [{"id": "string",
"patient": {"id": "string",
"title": "Baron",
"first_name": "string",
"last_name": "string"
},
"practitioner": {"id": "string",
"title": "Baron",
"first_name": "string",
"last_name": "string"
},
"location_id": "string",
"start_time": "2019-08-24T14:15:22Z",
"reserved_until": "2019-08-24T14:15:22Z",
"booking_confirmed_at": "2019-08-24T14:15:22Z",
"can_be_cancelled": false,
"cancellation_policy_hours": 0,
"count": "string",
"appointment_template_name": "string",
"cancelled_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"appointment_source": "string",
"video": false,
"location_name": "string",
"service": "string",
"source": "string",
"status": "string"
}
],
"count": 0
}