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
Request
- Base URLhttp://api-gateway-eu.phorest.com/third-party-api-server
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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 200
page number, default is 0 and is optional
Response
Rooms listed
Example response
{
"roomId": "ab-123",
"name": "123456",
"description": "The machine description",
"capacity": 1,
"capacityForGroup": true
}Changes
No recorded changes to this operation across all 2 revisions of this API.