OpenAPI Reference

The complete, interactive reference is the Swagger API reference — identical to the Swagger page every todoless instance serves at /api/docs. Set the server variables to your own instance to try requests there. The tables below are a quick overview.

Custom API endpoints

Method	Path	Auth
GET	/api/hook-health	public
GET	/api/setup-status	public
GET	/api/validate-invite	public
POST	/api/register	public
GET	/api/entries	auth
POST	/api/v1	auth
POST	/api/tasks	auth
POST	/api/tasks/{taskId}/subtasks	auth
PATCH	/api/tasks/{taskId}	auth
PATCH	/api/subtasks/{subtaskId}	auth
POST	/api/groceries	auth
PATCH	/api/groceries/{itemId}	auth

PocketBase collections

Collection	Base path
tasks	/api/collections/tasks/records
items	/api/collections/items/records
notes	/api/collections/notes/records
labels	/api/collections/labels/records
shops	/api/collections/shops/records
sprints	/api/collections/sprints/records
calendar_events	/api/collections/calendar_events/records
reminders	/api/collections/reminders/records
rewards	/api/collections/rewards/records
goals	/api/collections/goals/records
projects	/api/collections/projects/records
app_settings	/api/collections/app_settings/records
families	/api/collections/families/records

OpenAPI specification

Download the machine-readable spec: openapi.public.yaml.