2026.10.4
Home ▸ Template functions

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 represents a room or space in your home, such as the living room, kitchen, or garage. [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.

Tip

Automation actions can target entities by label through the visual editor, no template needed. Reach for label_entities() when you need to loop over or filter the entities inside a template expression.

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_entities("Critical") }}
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].) 
[
  "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 = 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_entities(
    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 entity IDs that have this label assigned. You can find labels in Settings > Areas, labels & zones.

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.
  • Uppercase and lowercase letters and spaces in a label name don’t matter. A label ID must match exactly.

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 entities with a specific label

Find out how many entities 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_entities("Critical") | count }}
Result (integerA whole number without decimal places, like 1, 42, or -5. Used for counts, indices, and whole values.) 
3

Check if any critical entity is unavailable

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

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_entities("Critical")
  | select("is_state", "unavailable")
  | list
  | count > 0
}}
Result (booleanA value that is either true or false. Used for on/off states, yes/no conditions, and similar binary choices.) 
false

List the states of all labeled entities

Display the current state of every entity that has 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] 
{% for entity_id in label_entities("Energy Monitoring") %}
  {{ state_attr(entity_id, "friendly_name") }}: {{ states(entity_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 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.

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_entities("Energy Monitoring")
  | map("states")
  | map("float", default=0)
  | sum
}}
Result (floatA number that can have decimal places, like 21.5 or 3.14. Used for temperatures, percentages, and other measurements that need precision.) 
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.

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: