Get all areas: areas

The areas template function returns a list of all 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 in your Home Assistant instance. Each area you’ve created in Home Assistant has a unique ID, and this function gives you all of them.

This is useful when you want to loop through every area in your home and do something with it. For example, you could check all areas for motion, count how many rooms have lights on, or build a dynamic dashboard that adapts to your areas. Since areas can be added or removed at any time, using areas() ensures your 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 your current setup.

Usage

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

{{ areas() }}

[
  "living_room",
  "kitchen",
  "bedroom",
  "hallway",
]

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.

areas() -> list[str]

Good to know

• Returns area IDs, not human-readable names. Pair with area_name to get names for display.
• The list is unordered. Apply | sort if you need a consistent order.

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 you have

A convenient way to see how many areas are set up in your Home Assistant instance.

{{ areas() | count }}

4

Check if any area has motion

Loop through all areas and check if any has an active motion sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more].

{% for area_id in areas() %}
  {% if area_entities(area_id)
      | select("match", "binary_sensor.")
      | select("is_state", "on")
      | list
      | count > 0 %}
    Motion in {{ area_name(area_id) }}!
  {% endif %}
{% endfor %}

Count lights on per room

Build a summary of how many lights are on in each area. This loops through all areas and counts the active lights in each one.

{% for id in areas() %}
  {% set lights = area_entities(id)
    | select("match", "light.")
    | select("is_state", "on")
    | list %}
  {% if lights | count > 0 %}
    {{ area_name(id) }}: {{ lights | count }} lights on
  {% endif %}
{% endfor %}

Living Room: 3 lights on
Kitchen: 1 lights on

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 area ID: area_id - Returns the area ID for a given area name, entity ID, or device ID.

• Get area name: area_name - Returns the friendly name of an area from its ID, entity ID, or device ID.

• Get entities in an area: area_entities - Returns a list of entity IDs associated with a given area.

• Get devices in an area: area_devices - Returns a list of device IDs associated with a given area.