Get all labels: labels

The labels template function returns a list of all labelLabels in Home Assistant allow grouping elements irrespective of their physical location or type. Labels can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers. Labels can be used in automations and scripts as a target for actions. Labels can also be used to filter data. [Learn more] IDs in your Home Assistant instance when called without an argument. When called with 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] ID, deviceA device is a model representing a physical or logical unit that contains entities. ID, or 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] ID, it returns only the labels assigned to that specific item.

Labels are tags you can assign to entities, devices, and areas for organization. This function is useful when you want to work with your labels programmatically. For example, you could list all labels in your system, check which labels are applied to a particular sensor, or build automationsAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] that act on items based on their label assignments. Since labels can be added or removed at any time, using labels() ensures your templatesA 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] always reflect your current setup.

Usage

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

{{ labels() }}

[
  "outdoor",
  "critical",
  "energy_monitoring",
]

{{ "light.living_room" | labels }}

[
  "outdoor",
  "critical",
]

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.

labels() -> list[str]
labels(
    lookup_value: str,
) -> list[str]

Function parameters

The following parameters can be provided to this function.

Good to know

• Without an argument, returns all label IDs. With an ID, returns only labels assigned to that specific entity, device, or area.
• Labels on a device or area do not roll up into the labels of their entities.
• Returns an empty list when the lookup value does not match or has no labels.

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.

Count how many labels you have

A convenient way to see how many labels are defined in your Home Assistant instance.

{{ labels() | count }}

3

Get labels for a specific entity

Find out which labels have been assigned to a particular entity.

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

[
  "critical",
  "energy_monitoring",
]

Get labels for an area

Check which labels are assigned to a specific area by passing its area ID.

{{ labels("living_room") }}

[
  "outdoor",
]

Check if an entity has a specific label

Determine whether a particular label has been applied to an entity.

{{ "critical" in labels("sensor.living_room_temperature") }}

true

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 label ID: label_id - Returns the label ID for a given label name.

• Get label name: label_name - Returns the friendly name of a label from its ID.

• Get label description: label_description - Returns the description of a label from its ID.

• Get areas with a label: label_areas - Returns a list of area IDs that have a specific label assigned.

• Get devices with a label: label_devices - Returns a list of device IDs that have a specific label assigned.

• Get entities with a label: label_entities - Returns a list of entity IDs that have a specific label assigned.