Room

Rooms group devices and each device can only be part of one room.

List rooms

List all available rooms

GEThttps://192.168.1.0/clip/v2/resource/room

Authorization

HueApplicationKey

Response

200401403404405406409429500503507

Room Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of RoomGet (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/room', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "children": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "services": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "metadata": {
        "name": "text",
        "archetype": "living_room"
      }
    }
  ]
}

Create room

Create a new room

POSThttps://192.168.1.0/clip/v2/resource/room

Authorization

HueApplicationKey

Body

application/json

typestring

Type of the supported resources (always room here)

childrenarray of ResourceIdentifier (object)

Child devices/services to group by the derived group

metadataobject

configuration object for a room

Response

200401403404405406409429500503507

Success

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of ResourceIdentifier (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/room', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "children": [
        {
          "rid": "00afc7d2-bae5-4613-8cd8-5ba0d064a572",
          "rtype": "light"
        }
      ],
      "metadata": {
        "name": "TV Room",
        "archetype": "tv"
      }
    }),
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Get room.

Get details of a single room from its given {roomId}

GEThttps://192.168.1.0/clip/v2/resource/room/{roomId}

Authorization

HueApplicationKey

Path parameters

roomId*string

ID of the room

Response

200401403404405406409429500503507

Room Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of RoomGet (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/room/{roomId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "children": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "services": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "metadata": {
        "name": "text",
        "archetype": "living_room"
      }
    }
  ]
}

Update room

Update a single room from its given {roomId}

PUThttps://192.168.1.0/clip/v2/resource/room/{roomId}

Authorization

HueApplicationKey

Path parameters

roomId*string

ID of the room

Body

application/json

typestring

Type of the supported resources (always room here)

childrenarray of ResourceIdentifier (object)

Child devices/services to group by the derived group

metadataobject

configuration object for a room

Response

200401403404405406409429500503507

Success

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of ResourceIdentifier (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/room/{roomId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Delete room

Delete a single room from its given {roomId}

DELETEhttps://192.168.1.0/clip/v2/resource/room/{roomId}

Authorization

HueApplicationKey

Path parameters

roomId*string

ID of the room

Response

200401403404405406409429500503507

Success

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of ResourceIdentifier (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/room/{roomId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}