Sign in
BlockedTimePresets

List blocked-time presets

Returns a paginated list of BlockedTimePresets at the given site, alphabetised by name. Use this to populate the preset picker in the operator calendar UI.

Requires the RESERVATIONS_VIEW permission on the site.

get/shop/blocked-time-presets

Query parameters

site_idstring required

Filter results by the site they belong to

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

A paginated list of BlockedTimePresets at the site.

Example response

{
  "data": [
    {
      "id": "65f1234567890abcdef12345",
      "name": "Lunch break",
      "duration": 30,
      "type": "break",
      "label": "Lunch",
      "color": "#ff8800"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.