Get entities for an integration: integration_entities

The integration_entities template function returns a list of 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] IDs that belong to a specific integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] or config entry. You can pass either a domain name (like hue) to get all entities for that integration, or a config entry title (like Living Room Hue Bridge) to narrow it down to a specific instance.

This is especially useful when you have multiple instances of the same integration and need to work with entities from only one of them. For example, if you have two Hue bridges, you can get the entities for each one separately by using their config entry titles. You can also use this to count how many entities an integration has created, or to check the state of all entities that belong to a particular integration at once.

Usage

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

{{ integration_entities("hue") }}

[
  "light.living_room",
  "light.bedroom",
  "sensor.hue_motion",
]

{{ "hue" | integration_entities }}

[
  "light.living_room",
  "light.bedroom",
  "sensor.hue_motion",
]

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.

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any

integration_entities(
    entry_name: str,
) -> list[str]

Function parameters

The following parameters can be provided to this function.

Good to know

• A domain name returns entities from every config entry of that integration. Use a config entry title to narrow down to one instance.
• Config entry title matches take precedence over domain matches, so a title that looks like a domain name is matched first as a title.
• Returns an empty list when nothing matches, rather than raising an error.

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 entities for an integration

Find out how many entities a specific integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] has registered.

{{ integration_entities("zwave_js") | count }}

42

Check if any entity from an integration is unavailable

Loop through all entities from an integration and check if any are in the unavailable state.

{{
  integration_entities("mqtt")
  | select("is_state", "unavailable")
  | list
  | count > 0
}}

false

Get entities from a specific config entry

When you have multiple instances of the same integration, use the config entry title to get entities for only one of them.

{{ integration_entities("Living Room Hue Bridge") }}

[
  "light.living_room_ceiling",
  "light.living_room_lamp",
]

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 ID: config_entry_id - Gets the config entry ID from an entity ID.

• Get config entry attribute: config_entry_attr - Gets a specific attribute from a config entry.

• Get entities in an area: area_entities - Returns a list of entity IDs associated with a given area.

• Get entity state: states - Returns the state value of an entity, or lets you iterate over all entity states.