The Task API helps you manage tasks and categories.
To use the Task API, you need an access token that you can get by authenticating with a user account, not a service account.
The API scopes are task and task.read.
You can get, create, and update tasks using the following API operations. You can also move tasks to another category.
| HTTP request | Description |
|---|---|
| POST /users/{userId}/tasks | Create a task |
| GET /users/{userId}/tasks | Get tasks |
| GET /tasks/{taskId} | Get a task |
| PATCH /tasks/{taskId} | Update part of a task |
| DELETE /tasks/{taskId} | Delete a task |
| POST /users/{userId}/tasks/{taskId}/move | Move a task to a category |
You can mark tasks as complete or incomplete using the following API operations.
| HTTP request | Description |
|---|---|
| POST /tasks/{taskId}/complete | Mark a task as complete |
| POST /tasks/{taskId}/incomplete | Mark a task as incomplete |
| POST /tasks/{taskId}/assignees/{userId}/complete | Mark an assignee's task as complete |
| POST /tasks/{taskId}/assignees/{userId}/incomplete | Mark an assignees' task as incomplete |
You can manage task categories using the following API operations.
| HTTP request | Description |
|---|---|
| POST /users/{userId}/task-categories | Create a task category |
| GET /users/{userId}/task-categories | Get task categories |
| GET /users/{userId}/task-categories/{categoryId} | Get a task category |
| PATCH /users/{userId}/task-categories/{categoryId} | Update part of a task category |
| DELETE /users/{userId}/task-categories/{categoryId} | Delete a task category |