Appointments
Find availability and book, inspect, cancel, or reschedule care.
The Doctronic API supports scheduled and ASAP appointments for a user in your organization.
Every appointment request must include the API Bearer token and the user's
X-Doctronic-User-ID header.
Scheduled care
- Set a complete user address with
PUT /address/before requesting availability or booking. - List available slots with
GET /appointments/scheduled/available-slots/. - Book the selected slot with
POST /appointments/scheduled/. - Persist the returned appointment ID in your system.
Do not assume a previously listed slot is still available at booking time. Handle a booking failure as the current source of truth and request availability again when appropriate.
ASAP care
Use POST /appointments/asap/ when the user should enter the next available care queue
rather than select a future time. Supply an Idempotency-Key when booking.
Appointment management
- List appointments with
GET /appointments/. - Retrieve one appointment with
GET /appointments/{appointment_id}/. - Cancel with
POST /appointments/{appointment_id}/cancel/. - Reschedule with
POST /appointments/{appointment_id}/reschedule/.
Collect booking fields before checkout
A user can be created with partial demographics, but first name, last name, and phone number
are required when booking an appointment. Booking also requires an address with line1, city,
state, and postalCode.
Use one idempotency key for one intended change
Scheduled booking, ASAP booking, cancellation, and rescheduling accept Idempotency-Key.
If a request times out, retry the same body with the same key. Use a new key only when the user
intends a different change. Results are retained for 24 hours.
The API returns Idempotency-Replayed: true when it replays a stored result. A reused key with a
different payload, or a key whose first request is still being processed, returns 409. If
idempotency coordination is temporarily unavailable, the API returns 503 without starting the
mutation.
See Errors and retries for the complete endpoint list and retry rules.