Get label name: label_name
The label_name template function returns the friendly, human-readable name of a 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] from its internal ID. Every label in Home Assistant has an ID (like energy_monitoring) and a display name (like “Energy Monitoring”), and this function converts the ID to the name.
This is especially useful for building dynamic messages and notificationsYou can use notifications to send messages, pictures, and more, to devices. [Learn more]. Instead of showing a technical label ID, you can display the actual name you (or whoever receives the message) recognize. For example, when listing the labels applied to 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] or deviceA device is a model representing a physical or logical unit that contains entities., you could convert each label ID returned by labels into its friendly name for a more readable output.
Usage
Here’s how to use this template function. Copy any example and adjust it to your setup.
{{ label_name("critical") }}
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 = 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
-
roundis 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 as0or"unknown", not the wordAny. -
= 0and= "common"are default values. You can leave outprecisionandmethod, androunduses these default values. -
defaulthas no=, but the parameter list marksdefaultas optional. If you leave outdefaultandroundgets a value that isn’t a number,roundraises 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 asdefault.
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 as5 -
float: a decimal number, such as3.14 -
bool:trueorfalse -
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"} -
datetimeandtimedelta: 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:
-
*argsmeans 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 theroundexample, show this value as the first parameter between the parentheses instead.
label_name(
lookup_value: str,
) -> str | None
Function parameters
The following parameters can be provided to this function.
Good to know
- Returns
Nonewhen the label does not exist. - Only takes a label ID, not a name. The name comes back as the display string you see in the UI.
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.
Display a label’s friendly name
Convert a label ID into its human-readable name.
{{ label_name("energy_monitoring") }}
Energy Monitoring
List all label names
Loop through all labels and display their friendly names using labels combined with label_name.
{% for lbl_id in labels() %}
{{ label_name(lbl_id) }}
{% endfor %}
Outdoor
Critical
Energy Monitoring
Show the labels on an entity as names
Get the labels assigned to an entity and display their friendly names instead of IDs.
{{
labels("sensor.living_room_temperature")
| map("label_name")
| join(", ")
}}
Critical, Energy Monitoring
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.
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:
-
Get label ID: label_id - Returns the label ID for a given label name.
-
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.