Get entities with a label: label_entities

The label_entities template function returns a list of entityAn 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] 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 entities tagged with that label.

This is useful when you want to act on a group of entities that share a common label, regardless of which areaAn area in Home Assistant is a logical grouping of devices and entities that are meant to match areas (or rooms) in the physical world: your home. For example, the living room area groups devices and entities in your living room. [Learn more] or deviceA device is a model representing a physical or logical unit that contains entities. they belong to. For example, if you label certain sensors as “Critical”, you could use label_entities to monitor all of them at once, or if you label energy-related entities as “Energy Monitoring”, you could build a dashboard that automatically includes every labeled entity. As you add or remove labels from entities, 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 stay current.

Usage

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

{{ label_entities("Critical") }}

[
  "sensor.living_room_temperature",
  "binary_sensor.front_door",
  "binary_sensor.smoke_detector",
]

{{ "Critical" | label_entities }}

[
  "sensor.living_room_temperature",
  "binary_sensor.front_door",
  "binary_sensor.smoke_detector",
]

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 default are required.

label_entities(
    label_id_or_name: str,
) -> list[str]

Function parameters

The following parameters can be provided to this function.

Good to know

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

Try it yourself

Ready to test this? Open Developer 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 entities with a specific label

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

{{ label_entities("Critical") | count }}

3

Check if any critical entity is unavailable

Monitor all entities with a specific label and report if any of them are unavailable.

{{
  label_entities("Critical")
  | select("is_state", "unavailable")
  | list
  | count > 0
}}

false

List the states of all labeled entities

Display the current state of every entity that has a given label.

{% for entity_id in label_entities("Energy Monitoring") %}
  {{ state_attr(entity_id, "friendly_name") }}: {{ states(entity_id) }}
{% endfor %}

Living Room Power: 120
Kitchen Power: 85
Dryer Power: 2400

Sum up energy usage from labeled entities

Calculate the total value across all entities with a specific label. This is useful for energy monitoring dashboards.

{{
  label_entities("Energy Monitoring")
  | map("states")
  | map("float", default=0)
  | sum
}}

2605.0

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.

Related template functions

These functions work well alongside this one:

• Get areas with a label: label_areas - Returns a list of area IDs that have a specific label assigned.

• Get devices with a label: label_devices - Returns a list of device IDs that have a specific label assigned.

• Get all labels: labels - Returns a list of all label IDs, or the labels assigned to a specific entity, device, or area.

• Get label ID: label_id - Returns the label ID for a given label name.

• Get label name: label_name - Returns the friendly name of a label from its ID.