Get Light

philips_hue.get_light

ActionBusiness appsconnection required

Calls the Philips Hue API with the connection's credentials.

Read one light's full state by its v2 UUID.

Ask about Philips Hue All Philips Hue nodes Provider API docs ↗

Connection

Required: Yes — the node will not save without one
Auth type: API key
Providers: Philips Hue
Secret shape: {"api_key": "…"} (the bridge application key), plus "access_token" for Hue's remote gateway
Config it needs: base_url
Resolved by: config.connection_id, else node.connection_id

Configuration

1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

Field	Type	Required	Default	Constraints	Example
light_id UUID of the light to read, as returned in the 'id' of a philips_hue.list_lights row.	string	Yes	—	—	3883f8bf-30a3-445b-ac06-b047d50599df

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "light_id": "3883f8bf-30a3-445b-ac06-b047d50599df"
}

Output

One shape.

result

Field	Type	Example
id The light's v2 UUID, which every other node takes as its 'light_id'.	string	—
id_v1 The CLIP v1 path for the same light, such as '/lights/8'.	string	—
type Always 'light' for this resource.	string	—
metadata.name The human-readable name the light was given.	string	—
metadata.archetype The fixture archetype, such as 'sultan_bulb'.	string	—
on.on True when the light is currently on.	boolean	—
dimming.brightness Current brightness as a percentage.	number	—
color_temperature.mirek Current colour temperature in mirek, or null.	number	—
color.xy.x Current CIE x colour coordinate.	number	—
color.xy.y Current CIE y colour coordinate.	number	—
owner.rid UUID of the device this light service belongs to.	string	—

{
  "color": {
    "xy": {
      "x": 0,
      "y": 0
    }
  },
  "color_temperature": {
    "mirek": 0
  },
  "dimming": {
    "brightness": 0
  },
  "id": "",
  "id_v1": "",
  "metadata": {
    "archetype": "",
    "name": ""
  },
  "on": {
    "on": false
  },
  "owner": {
    "rid": ""
  },
  "type": ""
}

Related Philips Hue nodes

See Get Light run in a workflow.

In a technical demo we add the Philips Hue connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demo Talk to sales