Find appointments
list_appointmentsUse this when someone asks when a patient is booked or what is booked on a day, or an appointment id is needed to move or cancel it. Returns up to 50 appointments in start order with id, patient and provider ids, times, status and edit time, for one day or one patient. Not for counting how busy days are, nor for procedures, notes or clinical details.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_appointments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endTime | No | End of the window. Without a patientId at most one day after the start, and one day by default; with one at most a year, and 90 days by default | |
| clinicId | No | Only this practice; every practice of the account when absent | |
| patientId | No | Only this patient, by the id find_patient returns | |
| startTime | No | Start of the window as an ISO 8601 time with the practice's UTC offset; defaults to now |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | ||
| range | Yes | ||
| hasMore | Yes | More appointments fall in the window than were returned | |
| appointments | Yes | Appointments in start order, canceled ones included, that the signed-in account can view. Procedures, notes, findings, treatments and patient names are never returned. |