---
title: "List rooms"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/room"
tags: ["Room"]
---

# List rooms

`GET /api/business/{businessId}/branch/{branchId}/room`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/room`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/room/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Query parameters

- `include_archived` boolean
- `updated_from` string
- `updated_to` string

## Response `200`

Rooms listed

- Room
  - `roomId` string, required
  - `name` string
  - `description` string
  - `color` integer
  - `capacity` integer
  - `capacityForGroup` boolean
  - `archived` boolean

## Other responses

- `400`: Bad Request
- `404`: Business or branch with the specified ids don't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/phorest/apis/third-party-api.md) - [All operations](https://skmtc.dev/phorest/apis/third-party-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phorest/apis/third-party-api/revisions/beea6ef29634?raw)