> For the complete documentation index, see [llms.txt](https://www.openhue.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.openhue.io/api/openhue-api-1/groupedlight.md).

# GroupedLight

API to manage grouped light services. These are offered by rooms, zones, and homes.

## List grouped lights

> List all grouped lights

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLight","description":"API to manage grouped light services. These are offered by rooms, zones, and homes."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GroupedLightGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"on":{"description":"Joined on control & aggregated on state. “on” is true if any light in the group is on.","$ref":"#/components/schemas/On"},"dimming":{"description":"Joined dimming control – “dimming.brightness” contains average brightness of group containing turned-on lights only.","$ref":"#/components/schemas/Dimming"},"alert":{"type":"object","description":"Joined alert control","properties":{"action_values":{"type":"array","items":{"type":"string"}}}},"signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal_values":{"type":"array","description":"Signals that the light supports.","items":{"$ref":"#/components/schemas/SupportedSignals"}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light":{"get":{"operationId":"getGroupedLights","summary":"List grouped lights","description":"List all grouped lights","tags":["GroupedLight"],"responses":{"200":{"description":"Grouped Light Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupedLightGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}}
```

## Get grouped light

> Get details of a single grouped light from its given \`{groupedLightId}\`.

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLight","description":"API to manage grouped light services. These are offered by rooms, zones, and homes."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GroupedLightGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"on":{"description":"Joined on control & aggregated on state. “on” is true if any light in the group is on.","$ref":"#/components/schemas/On"},"dimming":{"description":"Joined dimming control – “dimming.brightness” contains average brightness of group containing turned-on lights only.","$ref":"#/components/schemas/Dimming"},"alert":{"type":"object","description":"Joined alert control","properties":{"action_values":{"type":"array","items":{"type":"string"}}}},"signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal_values":{"type":"array","description":"Signals that the light supports.","items":{"$ref":"#/components/schemas/SupportedSignals"}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light/{groupedLightId}":{"get":{"operationId":"getGroupedLight","summary":"Get grouped light","description":"Get details of a single grouped light from its given `{groupedLightId}`.","tags":["GroupedLight"],"parameters":[{"name":"groupedLightId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the grouped light"}],"responses":{"200":{"description":"Grouped Light Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupedLightGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}}
```

## Update grouped light

> Update a single grouped light from its given \`{groupedLightId}\`.

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLight","description":"API to manage grouped light services. These are offered by rooms, zones, and homes."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"GroupedLightPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `grouped_light` here)","enum":["grouped_light"]},"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"dimming_delta":{"$ref":"#/components/schemas/DimmingDelta"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"color_temperature_delta":{"$ref":"#/components/schemas/ColorTemperatureDelta"},"color":{"$ref":"#/components/schemas/Color"},"alert":{"$ref":"#/components/schemas/Alert"},"signaling":{"$ref":"#/components/schemas/Signaling"},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"DimmingDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"brightness_delta":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage of full-scale increase delta to current dimlevel. Clip at Max-level or Min-level.\n"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"ColorTemperatureDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"mirek_delta":{"type":"integer","minimum":0,"maximum":347,"description":"Mirek delta to current mirek. Clip at mirek_minimum and mirek_maximum of mirek_schema."}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Alert":{"type":"object","description":"Joined alert control","properties":{"action":{"type":"string"}}},"Signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal":{"type":"string","description":"- `no_signal`: No signal is active. Write “no_signal” to stop active signal.\n- `on_off`: Toggles between max brightness and Off in fixed color.\n- `on_off_color`: Toggles between off and max brightness with color provided.\n- `alternating`: Alternates between 2 provided colors.\n","enum":["no_signal","on_off","on_off_color","alternating"]},"duration":{"type":"integer","minimum":0,"maximum":65534000,"description":"Duration has a max of 65534000 ms and a stepsize of 1 second.\nValues inbetween steps will be rounded.\nDuration is ignored for `no_signal`.\n"},"color":{"type":"array","minItems":1,"maxItems":2,"description":"List of colors to apply to the signal (not supported by all signals)","items":{"$ref":"#/components/schemas/Color"}}}},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light/{groupedLightId}":{"put":{"operationId":"updateGroupedLight","summary":"Update grouped light","description":"Update a single grouped light from its given `{groupedLightId}`.","tags":["GroupedLight"],"parameters":[{"name":"groupedLightId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the light"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedLightPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.openhue.io/api/openhue-api-1/groupedlight.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.