Sign in
Rooms

Retrieve a room

Returns the full Room for the given ID. Use this to populate an admin edit screen or to look up the room's capacity and availability when checking schedules.

Requires the RESERVATIONS_VIEW permission on the room's site.

get/shop/rooms/{roomId}

Response

A single Room.

Example response

{
  "data": {
    "id": "5dcb47800000000000000000",
    "organisation_id": "0193b6e0-3b56-7000-9f50-9d3d5e2c1111",
    "site_id": "0193b6e0-3b56-7000-9f50-9d3d5e2c2222",
    "name": "Treatment Room 1",
    "capacity": 1,
    "availability_rules": [
      {
        "date_from": "2021-02-15",
        "date_to": "2021-02-15",
        "time_from": "11:00",
        "time_to": "17:00"
      }
    ],
    "zones": [
      {
        "id": "5f1234567890abcdef123456",
        "name": "Pool Deck",
        "organisation_id": "22222222-2222-2222-2222-222222222222",
        "site_id": "11111111-1111-1111-1111-111111111111"
      }
    ]
  }
}

Changes