Get areas with a label: label_areas

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

This is useful when you organize your areas using labels and want to act on groups of rooms. For example, if you label certain areas as “Outdoor”, you could use label_areas to find all outdoor areas and then turn off their lights at night, or check the temperature in all rooms labeled “Heated”. As you add or remove labels from areas, 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 in sync.

Usage

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

{{ label_areas("Outdoor") }}

[
  "patio",
  "garden",
  "driveway",
]

{{ "Outdoor" | label_areas }}

[
  "patio",
  "garden",
  "driveway",
]

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_areas(
    label_id_or_name: str,
) -> list[str]

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns an empty list when the label does not exist or no areas carry it.
• Accepts either the label name or the label ID, matching by name first.

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 how many areas have a label

Find out how many areas are tagged with a specific label.

{{ label_areas("Outdoor") | count }}

3

List area names with a specific label

Get the friendly names of all areas that have a given label by combining label_areas with area_name.

{{
  label_areas("Outdoor")
  | map("area_name")
  | join(", ")
}}

Patio, Garden, Driveway

Turn off lights in all areas with a label

Use in an automation to find all areas tagged with a label and act on their entities. This example collects all light entities from areas labeled “Outdoor”.

{% for area_id in label_areas("Outdoor") %}
  {% for entity_id in area_entities(area_id)
    | select("match", "light.") %}
    {{ entity_id }}
  {% endfor %}
{% endfor %}

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 devices with a label: label_devices - Returns a list of device IDs that have a specific label assigned.

• Get entities with a label: label_entities - Returns a list of entity 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.