Get tasks

Use this action to fetch tasks from your Habitica account. Optional filters let you narrow the results down for more precise retrieval.

This action returns its result in a response variable, which you can use in later steps of the same automation or script.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get tasks from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select Habitica: Get tasks.
6. Select the Config entry of the character. Optionally, set one or more filters to narrow down the results.
7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as habitica.get_tasks. Store the result in a response variable so you can use it in later steps:

action: habitica.get_tasks
data:
  config_entry: 6b4be47a1fa7c3764f14cf756dc9899d
  type: todo
  priority: hard
response_variable: tasks

This fetches all to-dos with a difficulty of hard.

Options in YAML

Response data

The response variable contains a tasks list. Each entry describes a single Habitica task, including its title, notes, type, priority, checklist, and other task details.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual 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] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.