2026.10.4
Home ▸ Template functions

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

As a function 
{{ areas() }}
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].) 
[
  "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 = 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.
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 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 how many areas you have

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

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] 
{{ areas() | count }}
Result (integerA whole number without decimal places, like 1, 42, or -5. Used for counts, indices, and whole values.) 
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].

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 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.

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 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 %}
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: 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.

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: