Sign in
Practitioners

List a practitioner's scheduled availability

Returns the resolved availability windows for one or more practitioners over the requested date range. Windows mix rota-derived "regular" availability with CustomAvailabilityRule overrides (which can be either available or explicitly unavailable); the response carries an availability_type flag so consumers can tell them apart.

Use either a date-range (date_from / date_to, inclusive of whole days in the practitioner's timezone) or a date-time range (date_time_from / date_time_to, half-open) — supply one pair or the other, not both.

Practitioners are processed in the order they appear in practitioner_ids; the response is sorted by start time within each practitioner. Returns an empty list if no practitioners were supplied.

Requires the view ability on every supplied practitioner. A single forbidden practitioner aborts the request with 403.

get/shop/practitioner-scheduled-availability

Query parameters

practitioner_idsstring required
Example:5dcb47800000000000000001,5dcb47800000000000000002

Comma-separated list of practitioner IDs to compute availability for. The calling user must be able to view every practitioner; a single forbidden practitioner returns 403.

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

date_time_fromstring

Inclusive start timestamp (YYYY-MM-DD HH:mm:ss) to compute availability for. Required when date_from/date_to are not supplied. Use this form for sub-day queries.

date_time_tostring

Exclusive end timestamp. Required when date_from/date_to are not supplied. Must be strictly after date_time_from.

Response

The resolved practitioner availability windows.

Example response

{
  "data": [
    {
      "date_time_from": "2026-05-23T09:00:00+00:00",
      "date_time_to": "2026-05-23T17:00:00+00:00"
    }
  ]
}

Changes