Scheduling API

Scheduling API overview What the Scheduling API v1 covers, the flow from organization to synced appointment, what instance and organization tokens may do, and which features it requires. Identifiers: id and external_id How records are identified in the Scheduling API: the UUID id, your own external_id, references by id or external ID, uniqueness rules and filtering lists by external_id. Organizations endpoints Reference for listing, creating, updating and deleting organizations through the Scheduling API, including instance-token-only fields, settings, owners and the irreversible deletion flow. Users endpoints Reference for creating, reading, updating and deactivating practitioners, medical assistants, admins and patients, including roles, profiles, login control, invitations and seats. Availability types endpoints Reference for creating, reading, updating and deleting availability types: the kinds of appointment an organization offers, with slot length, colour, place and booking options. Appointment resources endpoints Reference for creating, reading, updating and archiving appointment resources, the places where in-person appointments take place, and how they connect to availability types. Availabilities endpoints Reference for creating, listing, moving and deleting availabilities, the blocks of time in which a practitioner offers an availability type, including atomic daily and weekly repeats. Free slots and booking How to list the bookable times of an availability type and book a confirmed appointment: slot rules, choosing the practitioner, patients created inline, notifications, limits and conflicts. Appointments endpoints Reference for reading, filtering and syncing appointments with updated_since, and for updating, rescheduling, cancelling and completing them through the Scheduling API.