---
title: tidybird
description: Household planning and task execution platform
canonical: https://www.tidybird.io/
---

# tidybird

tidybird helps household admins plan tasks, share priorities with housekeepers, and track execution.

## Key Links

- API docs (human): https://www.tidybird.io/docs/api
- API contract (OpenAPI): https://www.tidybird.io/openapi.json
- API catalog (linkset): https://www.tidybird.io/.well-known/api-catalog
- Health endpoint: https://www.tidybird.io/api/health
- Pricing: https://www.tidybird.io/pricing
- Create account: https://www.tidybird.io/sign-up

## Public API Summary

- Base path: `/api/v1`
- Authentication: `Authorization: Bearer <api_key>` or `x-api-key: <api_key>`
- Scopes: `plans:read`, `plans:write`, `inbox:read`, `inbox:write`, `meals:read`, `meals:write`, `meals:ai`
- Core endpoints:
  - `GET /api/v1/inbox`
  - `POST /api/v1/inbox`
  - `GET /api/v1/plans/week?anchorDate=YYYY-MM-DD`
  - `POST /api/v1/plans/:date/tasks`
  - `GET /api/v1/plans/:date/tasks`
  - `DELETE /api/v1/plans/:date/tasks/:taskId`
  - `GET|POST /api/v1/meals/catalog`
  - `GET /api/v1/meals/plans/:weekStart`
  - `POST /api/v1/meals/plans/:weekStart/entries`
  - `POST /api/v1/meals/plans/:weekStart/generate`
  - `POST /api/v1/meals/plans/:weekStart/analyze`