Get label ID: label_id

The label_id template function returns the unique 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] ID for a given label name. Every label in Home Assistant has an internal ID that stays the same even if you rename the label, and this function lets you look it up from the human-readable name.

This is useful when you need the label ID to pass to other label functions like label_areas, label_devices, or label_entities. For example, you could use it in an automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] to dynamically find all 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] or devicesA device is a model representing a physical or logical unit that contains entities. with a particular label by name, without needing to know the internal ID ahead of time.

Usage

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

{{ label_id("Critical") }}

critical

{{ "Critical" | label_id }}

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.

label_id(
    lookup_value: str,
) -> str | None

Function parameters

The following parameters can be provided to this function.

Good to know

• Returns None when no label matches the name.
• The match is case-sensitive. "critical" does not match a label named "Critical".

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.

Look up a label ID by name

Find the internal ID of a label using its friendly name.

{{ label_id("Energy Monitoring") }}

energy_monitoring

Use label ID to find all entities with that label

Combine label_id with label_entities to find all entities that have a specific label, using the label’s friendly name.

{{ label_entities(label_id("Critical")) }}

[
  "sensor.living_room_temperature",
  "binary_sensor.front_door",
]

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 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 all labels: labels - Returns a list of all label IDs, or the labels assigned to a specific entity, device, or area.

• 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.