v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Room

List rooms

Get a list of rooms for the specified business id and branch id. List can be filtered by DateTime of update with a possibility to include archived rooms

get/api/business/{businessId}/branch/{branchId}/room

Path parameters

businessIdstring required
branchIdstring required

Query parameters

include_archivedboolean

include archived rooms in the list

updated_fromstring

date-time from which the rooms have been updated onwards

updated_tostring

date-time to which the rooms has been updated backwards

number of rooms to return, max is 100

page number, default is 0 and is optional

Response

Rooms listed

roomIdstring required
namestring
descriptionstring
colorinteger
capacityinteger
capacityForGroupboolean
archivedboolean

Example response

{
  "roomId": "ab-123",
  "name": "123456",
  "description": "The machine description",
  "capacity": 1,
  "capacityForGroup": true
}