Skip to content

Task Manager

Manage tasks — list, get details, complete, and undo.

Access via grocy.tasks.

for task in grocy.tasks.list():
    print(f"{task.name} - due: {task.due_date}")

grocy.tasks.complete(task_id=1)

Class Reference

TaskManager(api_client)

Manage tasks and their completion status.

Access via grocy.tasks.

list(query_filters=None)

Get all tasks.

get(task_id)

Get a single task by ID.

Parameters:

Name Type Description Default
task_id int

The Grocy task ID.

required

complete(task_id, done_time=None)

Mark a task as completed.

Parameters:

Name Type Description Default
task_id int

The Grocy task ID.

required
done_time datetime | None

When the task was completed. Defaults to now.

None

undo(task_id)

Undo a task completion.

Parameters:

Name Type Description Default
task_id int

The Grocy task ID.

required