Get area ID: area_id

The area_id template function returns the unique area ID for a given area name, 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] ID, or deviceA device is a model representing a physical or logical unit that contains entities. ID. Every 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] in Home Assistant has an internal ID that stays the same even if you rename the area, and this function lets you look it up.

This is useful when you need the area ID to pass to other area functions like area_entities or area_devices, or when you want to find out which area a particular entity or device belongs to. For example, you could use it in an automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] to determine which room triggered a motion sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] and then act on all devices in that room.

Usage

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

{{ area_id("Living Room") }}

living_room

{{ "Living Room" | area_id }}

living_room

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.

area_id(
    lookup_value: str,
) -> str | None

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns None when no matching area is found for the lookup value.
• The area ID is stable and does not change when you rename the area, so it is safe to hard-code in templates.
• When an entity or device has no area assigned, the result is None even if the entity itself exists.

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.

Find the area of an entity

Look up which area a specific entity belongs to.

{{ area_id("sensor.living_room_temperature") }}

living_room

Find the area of a device

Look up which area a device is assigned to by passing its device ID.

{{ area_id("deadbeefdeadbeefdeadbeef") }}

kitchen

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

• Get all areas: areas - Returns a list of all area IDs in your Home Assistant instance.