To Do API
Bramble To Do: shared lists, their members, and tasks with due dates, priorities and repeats. Works with an API key.
- Address
https://<your-org>.brambleit.cloud/api- Sign-in
- Signed-in session,
X-API-Key, or a Bramble app access token (Authorization: Bearer). - Endpoints
- 14
- OpenAPI
- todo.json
- Guides
- How To Do works
List roles. Each member of a list is an owner, editor or viewer.
Resources
Lists & tasks
Lists, their members, and the tasks in them.
| Method | Path | Summary |
|---|---|---|
| GET | /v1/app/todo/lists | List the caller's ToDo lists |
| POST | /v1/app/todo/lists | Create a list. Creator becomes the list's owner |
| PATCH | /v1/app/todo/lists/:id | Update a list's name, icon, color or position |
| DELETE | /v1/app/todo/lists/:id | Delete a list. Requires owner role on the list |
| GET | /v1/app/todo/lists/:id/members | List a list's owner and members |
| GET | /v1/app/todo/lists/:id/available-users | List tenant staff users not already on the list |
| POST | /v1/app/todo/lists/:id/members | Add a member to a list |
| PATCH | /v1/app/todo/lists/:id/members/:userId | Change a member's role |
| DELETE | /v1/app/todo/lists/:id/members/:userId | Remove a member from a list |
| GET | /v1/app/todo/lists/:id/tasks | List a list's (non-deleted) tasks |
| POST | /v1/app/todo/lists/:id/tasks | Add a task to a list |
| PATCH | /v1/app/todo/lists/:id/tasks/:taskId | Update a task's fields |
| PATCH | /v1/app/todo/lists/:id/tasks/:taskId/move | Move a task between status columns or reorder it within one |
| DELETE | /v1/app/todo/lists/:id/tasks/:taskId | Soft-delete a task. Requires editor or owner role on the list |