2026.10.4
Home ▸ Template functions

Get config entry attribute: config_entry_attr

The config_entry_attr template function returns a specific attribute from a config entry, identified by its config entry ID. You can retrieve attributes like domain, title, state, source, disabled_by, and pref_disable_polling. It returns None if the config entry does not exist.

This is useful for inspecting the configuration behind your 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]. For example, you might want to check if a config entry is still loaded and working, find out which integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] domain it belongs to, or display the title of the config entry in a notificationYou can use notifications to send messages, pictures, and more, to devices. [Learn more]. Combined with config_entry_id, you can trace any entity back to its config entry and read details about it.

Usage

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

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] 
{{ config_entry_attr("01234567890abcdef01234567890abcd", "title") }}
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 Hue Bridge

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.
config_entry_attr(
    config_entry_id: str,
    attr_name: str,
) -> Any

Function parameters

The following parameters can be provided to this function.

config_entry_id string Required

The config entry ID to look up. You can get this from config_entry_id.

attr_name string Required

The attribute to retrieve. Must be one of: domain, title, state, source, disabled_by, or pref_disable_polling.

Available attributes

The following attributes can be retrieved from a config entry:

  • domain: The integration domain (for example, hue, zwave_js).
  • title: The user-defined title of the config entry.
  • state: The current state of the config entry (for example, loaded, setup_error, not_loaded).
  • source: How the config entry was created (for example, user, discovery).
  • disabled_by: Why the config entry is disabled, or None if it is not disabled.
  • pref_disable_polling: Whether polling has been disabled for this config entry.

Good to know

  • Returns None when the config entry does not exist.
  • Only the fixed attribute names listed above are allowed. Any other attribute name causes the error Invalid config entry attribute, even if the config entry doesn’t exist.
  • The config entry ID must be text. If it’s None, the template fails with the error Must provide a config entry ID. This happens, for example, when you pass the result of config_entry_id for an entity that you set up in YAML, because that entity has no config entry.
  • The input is the config entry ID, not an entity ID. Resolve from an entity with config_entry_id first.

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.

Check the state of a config entry from an entity

Look up the config entry behind an entity and check its state to see if the integration is running.

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 entry_id = config_entry_id("light.living_room") %}
{{ config_entry_attr(entry_id, "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".) 
loaded

Get the integration domain for an entity

Find out which integration is responsible for a specific entity.

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 entry_id = config_entry_id("sensor.power_meter") %}
{{ config_entry_attr(entry_id, "domain") }}
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".) 
shelly

Check if a config entry was discovered automatically

Determine whether a config entry was set up manually or discovered automatically.

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 entry_id = config_entry_id("light.bedroom") %}
{{ config_entry_attr(entry_id, "source") }}
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".) 
discovery

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: