Get config entry ID: config_entry_id

The config_entry_id template function returns the config entry ID that an 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] belongs to. Every entity that is created by an integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] is tied to a config entry, and this function lets you look up that connection. It returns None if the entity does not exist in the registry.

This is useful when you need to look up details about the config entry behind an entity using config_entry_attr. For example, you might want to find out which integration domain an entity came from, check whether the config entry is still active, or group entities by their config entry. It is also helpful for debugging, letting you trace an entity back to the configuration that created it.

Usage

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

{{ config_entry_id("light.living_room") }}

01234567890abcdef01234567890abcd

{{ "light.living_room" | config_entry_id }}

01234567890abcdef01234567890abcd

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.

config_entry_id(
    entity_id: str,
) -> str | None

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns None for helper entities and YAML-configured entities, which have no config entry.
• Returns None when the entity does not exist in the registry yet, which can happen right after creation.

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 integration domain for an entity

Combine config_entry_id with config_entry_attr to find out which integration domain an entity belongs to.

{{ config_entry_attr(config_entry_id("light.living_room"), "domain") }}

hue

Check if an entity’s config entry is loaded

Verify that the config entry behind an entity is in the loaded state, which means the integration is running normally.

{{
  config_entry_attr(
    config_entry_id("sensor.power_meter"), "state"
  )
}}

loaded

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 config entry attribute: config_entry_attr - Gets a specific attribute from a config entry.

• Get entities for an integration: integration_entities - Returns a list of entity IDs tied to an integration or config entry.

• Get entity name: entity_name - Gets the friendly name of an entity from its entity ID.