Sign in
Rooms

List a room's scheduled availability

Returns the resolved availability windows for one or more rooms over the requested date range. Rooms derive their schedule from the parent site's bookable hours plus any per-room custom-availability rules; the response mixes both and tags each row with an availability_type.

Use either a date-range (date_from / date_to) or a date-time range (date_time_from / date_time_to). All date/datetime parameters are parsed in the calling site's timezone using the YYYY-MM-DD HH:mm:ss format (date-only values are also accepted).

Rooms are processed in the order supplied; the response is sorted by start time within each room.

Requires the view ability on every supplied room.

get/shop/room-scheduled-availability

Query parameters

room_idsstring required
Example:5dcb47800000000000000001,5dcb47800000000000000002

Comma-separated list of room IDs to compute availability for. The calling user must be able to view every room; a single forbidden room 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 room 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

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