Ctrlk
GitHubHue Developer Portal
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Room

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

List rooms

get

List all available rooms

Authorizations
hue-application-keystringRequired
Responses
200

Room Success Response

application/json
get/clip/v2/resource/room
GET /clip/v2/resource/room HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "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

post

Create a new room

Authorizations
hue-application-keystringRequired
Body
typestringOptional

Type of the supported resources (always room here)

Responses
200

Success

application/json
post/clip/v2/resource/room
POST /clip/v2/resource/room HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "children": [
    {
      "rid": "00afc7d2-bae5-4613-8cd8-5ba0d064a572",
      "rtype": "light"
    }
  ],
  "metadata": {
    "name": "TV Room",
    "archetype": "tv"
  }
}
{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Get room.

get

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

Authorizations
hue-application-keystringRequired
Path parameters
roomIdstringRequired

ID of the room

Responses
200

Room Success Response

application/json
get/clip/v2/resource/room/{roomId}
GET /clip/v2/resource/room/{roomId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "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

put

Update a single room from its given {roomId}

Authorizations
hue-application-keystringRequired
Path parameters
roomIdstringRequired

ID of the room

Body
typestringOptional

Type of the supported resources (always room here)

Responses
200

Success

application/json
put/clip/v2/resource/room/{roomId}
PUT /clip/v2/resource/room/{roomId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "type": "text",
  "children": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ],
  "metadata": {
    "name": "text",
    "archetype": "living_room"
  }
}
{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Delete room

delete

Delete a single room from its given {roomId}

Authorizations
hue-application-keystringRequired
Path parameters
roomIdstringRequired

ID of the room

Responses
200

Success

application/json
delete/clip/v2/resource/room/{roomId}
DELETE /clip/v2/resource/room/{roomId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

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

Last updated

Was this helpful?