Sign in
BlockedTimes

List blocked times

Returns every BlockedTime at the given site whose window intersects the date_from..date_to range. Use this to render the operator calendar's "blocked" overlays alongside bookings and appointments.

Both date_from and date_to are required and inclusive.

Requires the RESERVATIONS_VIEW permission on the site.

get/shop/blocked-times

Query parameters

site_idstring required

Filter results by the site they belong to

date_fromstring date required

First date to include in the listing, inclusive. ISO-8601 YYYY-MM-DD in the site's timezone.

date_tostring date required

Last date to include in the listing, inclusive. ISO-8601 YYYY-MM-DD in the site's timezone.

Response

A list of BlockedTimes falling within the requested date range.

Example response

{
  "data": [
    {
      "id": "65f1234567890abcdef12345",
      "start_time": "2026-06-01T09:00:00+01:00",
      "end_time": "2026-06-01T09:30:00+01:00",
      "type": "cleaning",
      "label": "Deep clean",
      "notes": "Used the extra steamer",
      "color": "#ff8800"
    }
  ]
}

Changes