2026.10.4
Home ▸ Template functions

Get devices with a label: label_devices

The label_devices template function returns a list of deviceA device is a model representing a physical or logical unit that contains entities. IDs that have a specific labelLabels in Home Assistant allow grouping elements irrespective of their physical location or type. Labels can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers. Labels can be used in automations and scripts as a target for actions. Labels can also be used to filter data. [Learn more] assigned. You can specify the label by its name or by its internal ID. This gives you all devices tagged with that label.

This is useful when you organize your devices using labels and want to act on or inspect a specific group. For example, if you label battery-powered devices as “Battery”, you could use label_devices to find them all and check their battery levels, or if you label certain devices as “Guest Room”, you could quickly find and control all devices for your guests. As you add or remove labels from devices, the list automatically updates, so your automationsAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] and templatesA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more] always reflect the current state.

Usage

Here’s how to use this template function. Copy any example and adjust it to your setup.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more] 
{{ label_devices("Battery") }}
Result (listAn ordered collection of values, like a list of entity IDs or a list of numbers. Written with square brackets in templates, for example [1, 2, 3].) 
[
  "a1b2c3d4e5f6a1b2c3d4e5f6",
  "f6e5d4c3b2a1f6e5d4c3b2a1",
]

Function signature

The signature is a technical summary of this template function. It shows the name of the function, the values (called parameters) it accepts, and what type of data each parameter expects (for example, a piece of text or a number).

Function parameters that have a = with a value after them are optional. If you leave them out, the default value shown is used automatically.

Function parameters without a = are usually required. A few optional parameters have no default value, so the signature shows them without a = as well. To check whether a parameter is required, look at the parameter list below the signature. Each parameter is marked as Required or Optional.

The most common optional parameter without a default value is default. The default parameter sets the value a function returns when the function can’t produce a result, for example, when float gets text that isn’t a number. If you leave out default, there is no fallback value, so most functions raise an error and the template fails. The parameter list of each function says what happens. If you set default, the function returns your value instead.

How to read a signature

Here is the signature of the round filter as an example:

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any
  • round is the name of the function.
  • Between the parentheses are the parameters. Each parameter has a name, followed by a colon and the type of value the parameter expects. The type only tells you what kind of value to pass. For default: Any, you pass a value of any type, such as 0 or "unknown", not the word Any.
  • = 0 and = "common" are default values. You can leave out precision and method, and round uses these default values.
  • default has no =, but the parameter list marks default as optional. If you leave out default and round gets a value that isn’t a number, round raises an error.
  • -> shows the type of value the function returns.
  • Inside a signature, | means “or”. This function returns a decimal number, a whole number, or the value you passed as default.

round is a filter, so the first parameter, value, is the value before the |. For example, {{ 3.14159 | round(2) }} returns 3.14.

The types you’ll see most often:

  • str: text, such as "hello"
  • int: a whole number, such as 5
  • float: a decimal number, such as 3.14
  • bool: true or false
  • list: a list of values, such as [1, 2, 3]. list[str] is a list of texts.
  • dict: a set of keys and values, such as {"name": "Kitchen"}
  • datetime and timedelta: a date and time, and a duration. For details, refer to Dates and times.
  • None: no value
  • Any: any type of value

Some signatures use special forms:

  • *args means you can pass any number of values, separated by commas. For example, average(1, 2, 3).
  • value | name(...) means the function is a filter. The value before the | is passed to the filter as its first parameter. Some filter signatures, like the round example, show this value as the first parameter between the parentheses instead.
label_devices(
    label_id_or_name: str,
) -> list[str]

Function parameters

The following parameters can be provided to this function.

label_id_or_name string Required

The label name or ID to look up. Returns the device IDs that have this label assigned. You can find labels in Settings > Areas, labels & zones.

Good to know

  • Only returns devices with the label assigned directly. Labels applied to entities or areas do not roll up to their devices.
  • Returns an empty list when the label does not match any devices.

Try it yourself

Ready to test this? Open Settings > Tools > Template, paste the example into the Template editor, and watch the result update on the right. Edit the values to see how the function adapts to your own entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more].

More examples

Real scenarios where this function comes up in automations and templates. Copy any example and adapt it to your setup.

Count devices with a specific label

Find out how many devices are tagged with a given label.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more] 
{{ label_devices("Battery") | count }}
Result (integerA whole number without decimal places, like 1, 42, or -5. Used for counts, indices, and whole values.) 
2

Get device names for a label

List the friendly names of all devices that have a specific label by combining label_devices with device_name.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more] 
{% for device_id in label_devices("Battery") %}
  {{ device_name(device_id) }}
{% endfor %}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
Living Room Motion Sensor
Front Door Sensor

Check battery levels of labeled devices

Find all devices with a “Battery” label and check their battery sensor entities. This collects the battery-level entities for all labeled devices.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more] 
{% for device_id in label_devices("Battery") %}
  {% set batteries = device_entities(device_id)
    | select("match", "sensor.")
    | select("search", "battery")
    | list %}
  {% for entity_id in batteries %}
    {{ device_name(device_id) }}: {{ states(entity_id) }}%
  {% endfor %}
{% endfor %}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
Living Room Motion Sensor: 85%
Front Door Sensor: 42%

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with your template and expected result, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain or fix templates when you describe what you want in plain language.

Related template functions

These functions work well alongside this one: