List bookings
list_bookingsRetrieve bookings with filters for date range, status, patient, or clinician, and handle recall statuses without time windows. Returns paginated results.
Instructions
Bookings in the Organization. Diary queries need start_time_from and start_time_to (UTC; a bare date is taken as the whole day), a range of at most 30 days, or 90 days with patient_id, ordered by start_time. For the recall statuses awaiting_recall, overdue_for_recall, recall_expired and recall_canceled omit the time window (those bookings have no start_time; results are ordered by recall_due_date); did_not_attend still needs it. Filters are ANDed and sent as documented: clinician_id, patient_id, status, updated_since. Patient names are returned; their contact details and the booking's free-text information only with include_contact_details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | next_cursor from a previous call, to continue where it stopped (send the same filters) | |
| status | No | ||
| patient_id | No | Only this patient's bookings (allows a 90-day window) | |
| max_results | No | Maximum number of records to return (pages of up to 100 are fetched until this is reached) | |
| clinician_id | No | ||
| start_time_to | No | Inclusive upper bound for start_time, YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD (a bare date means the end of that day, 23:59:59Z, so a 31-day calendar month given as bare dates is 31 days and must be split) | |
| updated_since | No | Only bookings updated since this UTC time | |
| start_time_from | No | Inclusive lower bound for start_time, YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD | |
| include_contact_details | No | Include patient contact details, date of birth, NHS number, address, payor details and the booking's information fields, and stop redacting email addresses, phone numbers, NHS-number-shaped digit groups and UK postcodes typed into names and other text |