home-assistant.io/source/_integrations/todo.markdown

title, description, ha_domain, ha_release, ha_category, ha_quality_scale, ha_codeowners, ha_integration_type

title	description	ha_domain	ha_release	ha_category	ha_quality_scale	ha_codeowners	ha_integration_type
To-do	Instructions on how to use To-do Lists within Home Assistant.	todo	2023.11	To-do List	internal	@home-assistant/core	entity

The To-do List integration provides todo list entities, allowing other integrations to integrate To-do Lists into Home Assistant. To-do lists are shown on the To-do list dashboard for tracking items and whether or not they have been completed.

{% include integrations/building_block_integration.md %}

Viewing and managing To-do lists

Each To-do list is represented as its own entity in Home Assistant and can be viewed and managed on a to-do list dashboard. You can find the to-do list dashboard in the main sidebar of your Home Assistant instance.

The state of a To-do List entity

The state of a To-do List entity is a number, which represents the number of incomplete items in the list.

Services

Some To-do List integrations allow Home Assistant to manage the To-do Items in the list. The services provided by some To-do List entities are described below or you can read more about Service Calls.

Service todo.create_item

Add a new To-do Item. A To-do list target is selected with a Target Selector and the data payload supports the following fields:

Service data attribute	Optional	Description	Example
summary	no	A short summary or subject for the To-do Item.	Submit Income Tax Return
status	yes	The overall status of the To-do Item.	needs_action or completed

This is a full example of service call in YAML:

service: todo.create_item
target:
  entity_id: todo.personal_tasks
data:
  summary: "Submit Income Tax Return"
  status: "needs_action"

Service todo.update_item

Update a To-do Item. A To-do list target is selected with a Target Selector and the data payload supports the following fields:

Service data attribute	Optional	Description	Example
uid	yes	The Unique identifier of the To-do Item to update.	bY1PVzZkni1qQQlkanTvBA
summary	yes	A short summary or subject for the To-do Item.	Submit Income Tax Return
status	yes	The overall status of the To-do Item.	needs_action or completed

To-do Items can be identified using either a uid or summary. This is a full example of a service call that updates the status of a To-do Item based on the name.

service: todo.update_item
target:
  entity_id: todo.personal_tasks
data:
  summary: "Submit Income Tax Return"
  status: "completed"

Service todo.delete_item

Delete a To-do Item. A To-do list target is selected with a Target Selector and the data payload supports the following fields:

Service data attribute	Optional	Description	Example
uid	yes	The Unique identifier of the To-do Item to update.	bY1PVzZkni1qQQlkanTvBA
summary	yes	A short summary or subject for the To-do Item.	Submit Income Tax Return

To-do Items can be identified using either a uid or summary. This is a full example of a service call that delete's a To-do Item with the specified name.

service: todo.delete_item
target:
  entity_id: todo.personal_tasks
data:
  summary: "Submit Income Tax Return"