v1

latestSwagger 2.02026-08-06115129197.7 KB

Blockages

List blockages

Returns blockages (time-off / unavailability windows) overlapping the requested date range. Filter by location and/or employee using either MyTime ids or partner/external ids. Recurring blockages are expanded to the individual occurrences that fall within the window.

get/blockages

Query parameters

location_idinteger

Filter by the location MyTime id. Provide this or location_external_id.

location_external_idstring

Filter by the location partner/external id. A supplied value that does not resolve returns 404.

employee_idinteger

Filter by the employee MyTime id. Provide this or employee_external_id.

employee_external_idstring

Filter by the employee partner/external id. A supplied value that does not resolve returns 404.

start_datestring date required

ISO8601 start of the date range to list blockages for, e.g. 2026-07-01.

end_datestring date required

ISO8601 end of the date range to list blockages for, e.g. 2026-07-31.

Headers

X-Subdomainstring

Merchant subdomain - Optional

Response

Blockages response

Example response

{
  "blockages": [
    {
      "schedule": {
        "frequency_interval": 1,
        "interval_datatype": "weeks",
        "end_date": "2026-12-31"
      }
    }
  ]
}