2026.4.1
Home ▸ Template functions

Get object attribute: attr

The attr filter reads an attribute from an object by name, the same way a dot does. Writing foo | attr("bar") is exactly like writing foo.bar. The difference is that with attr, the attribute name can come from a variable or be built at the moment the template runs, instead of being written into the template as fixed text.

This is useful when you don’t know in advance which attribute you need to read. You might store an attribute name in a variable and look it up on a state object, or loop over a list of attribute names and read each one in turn. For most everyday templates, a regular dot (states.sensor.temperature.state) is simpler and should be preferred.

Usage

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

As a filter 
{{ states.sensor.temperature | attr("state") }}
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".) 
21.5

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.

attr(
    value: Any,
    name: str,
) -> Any

Function parameters

The following parameters can be provided to this filter.

value any Required

The object to read from. Most often a state object like states.sensor.temperature.

name string Required

The attribute to read, as text. Common values include state, entity_id, last_changed, last_updated, or any attribute your entity reports (for example, brightness on a light or temperature on a climate entity).

Using a variable name

Use a variable to decide which attribute to read from an object at runtime.

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] 
{% set field = "state" %}
{{ states.sensor.temperature | attr(field) }}
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".) 
21.5

Good to know

  • This reads object attributes, not entity state attributes. For entity attributes, use state_attr instead.
  • When the attribute does not exist, it produces an undefined value, which pairs well with | default(value).

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.

Access entity attributes dynamically

Retrieve different attributes from an entity state object based on a variable.

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] 
{% set prop = "last_changed" %}
{{ states.light.living_room | attr(prop) }}
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".) 
2026-04-03 10:15:00+00:00

Iterate over multiple attributes

Loop over a list of attribute names and retrieve each one from a state object.

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] 
{% set fields = ["entity_id", "state"] %}
{% for field in fields %}
  {{ field }}: {{ states.sensor.temperature | attr(field) }}
{% 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".) 
entity_id: sensor.temperature
state: 21.5

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: