SMsmartthings
Rooms

Get a Room

Get details of a specific Room.

get/locations/{locationId}/rooms/{roomId}

Request

Response

A Room.

allowedstring[]

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>
roomIdstring uuid required

The ID of the room.

locationIdstring required

A unique location identifier. This is not guaranteed to be a valid UUID.

namestring required

A name for the room (e.g. Living Room)

backgroundImagestring

Not currently in use.

createdstring date-time

The timestamp of when a room was created in UTC.

lastModifiedstring date-time

The timestamp of when a room was last updated in UTC.

Example response

{
  "roomId": "bdd8a15f-33d4-41fc-b33c-75ce85e99d24",
  "locationId": "6b3d1909-1e1c-43ec-adc2-5f941de4fbf9",
  "name": "Living Room",
  "created": 1547920800,
  "lastModified": 1548007200,
  "indoorMap": {
    "mapRoomId": "6b3d1909-1e1c-43ec-adc2-5f941de4fbf8",
    "color": "some color code"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.