Sign in
Practitioners

List custom availability rules for a practitioner

Returns the PractitionerCustomAvailability rules for the practitioner. Each rule is an ad-hoc override to the regular rota — either opening an extra window (is_available: true) or blocking one off (is_available: false).

Use the date, date_time_from, date_time_to, and is_available query parameters to narrow the result set. Results are paginated.

get/shop/practitioners/{practitionerId}/custom-availability

Query parameters

datestring date

Return only rules that overlap this calendar day (in the practitioner's timezone).

date_time_fromstring date-time

Return only rules ending after this ISO 8601 timestamp.

date_time_tostring date-time

Return only rules starting before this ISO 8601 timestamp.

is_availableboolean

Filter by whether the rule opens (true) or blocks (false) bookings.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

A paginated list of PractitionerCustomAvailability rules for the practitioner.

Example response

{
  "data": [
    {
      "date_time_from": "2026-06-01T09:00:00+01:00",
      "date_time_to": "2026-06-01T17:00:00+01:00",
      "offerings": [
        {
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ]
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes