Overview
The Tasks API (Quick Tasks) enables you to manage tasks, sub-tasks, and task boards programmatically. Create, update, and track tasks assigned to your team members.
Key Concepts
Task Boards
Task boards are containers that organize tasks. Each account can have multiple task boards for different departments, projects, or workflows.
Tasks
Tasks are work items assigned to users with:
- Title and description
- Start time and due date
- Status (draft, published, completed)
- Labels for categorization
- Sub-tasks for breaking down work
- Attachments
Task Types
| Type | Description |
|---|---|
oneTime | Single occurrence task (default) |
recurring | Repeating task on a schedule |
Task Statuses
| Status | Description |
|---|---|
draft | Not yet published to assignees |
published | Visible to assigned users |
completed | Marked as done |
Group Tasks vs Individual Tasks
- Group task: Multiple
userIdsin one request - all users see the same task - Individual tasks: Separate API calls for each user - each gets their own task instance
Assignment RuleIf
userIdsis empty, the task status must bedraftand cannot be archived. Tasks must have assigned users to be published.
Available Endpoints
Task Boards
| Method | Endpoint | Description |
|---|---|---|
| GET | /tasks/v1/taskboards | Get all task boards |
Tasks
| Method | Endpoint | Description |
|---|---|---|
| GET | /tasks/v1/taskboards/{taskBoardId}/tasks | Get tasks |
| POST | /tasks/v1/taskboards/{taskBoardId}/tasks | Create task |
| PUT | /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId} | Update task |
| DELETE | /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId} | Delete task |
Labels
| Method | Endpoint | Description |
|---|---|---|
| GET | /tasks/v1/taskboards/{taskBoardId}/labels | Get task labels |
Sub-Tasks
| Method | Endpoint | Description |
|---|---|---|
| GET | /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks | Get sub-tasks |
| POST | /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks | Create sub-task |
| PUT | /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks/{subTaskId} | Update sub-task |
| DELETE | /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks/{subTaskId} | Delete sub-task |
Constraints
| Constraint | Value |
|---|---|
| Max results per page | 100 |
| Timestamps | Unix epoch (seconds) |
| Description format | UTF-8 text |
Authentication
All endpoints require authentication via API key or OAuth 2.0.
Required Scopes
| Scope | Operations |
|---|---|
| quick_tasks.read | GET task boards, tasks, labels, sub-tasks |
| quick_tasks.write | POST/PUT tasks, sub-tasks |
| quick_tasks.delete | DELETE tasks, sub-tasks |
Attachments
To add attachments to task descriptions:
- Upload files via the Attachments API with
featureType: quicktasks - Include the
fileIdin the task description
Attachment ReplacementWhen updating a task, new attachments replace existing ones. Include all attachments you want to keep in the update request.
Guide Pages
| Page | Description |
|---|---|
| Task Boards | List available task boards |
| Managing Tasks | Create, update, delete, and query tasks |
| Labels | Retrieve task labels |
| Sub-Tasks | Manage sub-tasks within tasks |
Updated 6 months ago
Did this page help you?
