---
title: "List Rooms"
method: GET
path: "/locations/{locationId}/rooms"
tags: ["Rooms"]
---

# List Rooms

`GET /locations/{locationId}/rooms`

## Request

- Base URL: `https://api.smartthings.com/v1`
- URL: `https://api.smartthings.com/v1/locations/{locationId}/rooms`
- Auth: OAuth 2
  - Implicit: `https://auth-global.api.smartthings.com`
  - Scopes: `r:locations:*`
- TypeScript: <https://skmtc.dev/smartthings/apis/smartthings-api/docs/locations/:locationId/rooms/get.ts> (a function with typed inputs; its response is checked against the schema)

List all Rooms currently available in a Location.

## Response `200`

An array of Rooms

- PagedRooms: Represents a single page of Rooms available in a Location.
  - `items` Room[], required
    - `allowed` string[]: List of client-facing action identifiers that are currently permitted for the user. If the value of this property is not null, then any action not included in the list value of the property is currently prohibited for the user. If the value of this property is null (or absent), then no permission-related information is being provided. <ul> <li> d:rooms - the user can delete the room <li> w:rooms - the user can edit the room </ul>
    - `roomId` string, uuid, required: The ID of the room.
    - `locationId` string, required: A unique location identifier. This is not guaranteed to be a valid UUID.
    - `name` string, required: A name for the room (e.g. Living Room)
    - `backgroundImage` string: Not currently in use.
    - `created` string, date-time: The timestamp of when a room was created in UTC.
    - `lastModified` string, date-time: The timestamp of when a room was last updated in UTC.
    - `indoorMap` object: Data used for indoor map
      - `mapRoomId` string: The reference id for the room map
      - `color` string: Map Room Color
  - `_links` Links
    - `next` Link
      - `href` string: An absolute URL linking to a resource.
    - `previous` Link
      - `href` string: An absolute URL linking to a resource.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too many requests
- `default`: Unexpected error

---

[API](https://skmtc.dev/smartthings/apis/smartthings-api.md) - [All operations](https://skmtc.dev/smartthings/apis/smartthings-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartthings/apis/smartthings-api/revisions/2788a4236800?raw)