Task Lists

The Task list object represents a task list within the project management system. It sits between Boards and Tasks, meaning it belongs to a board and contains multiple tasks.

You can find out more about task lists in our Help documentation: Task lists

Following diagram shows task lists in our data hierarchy:

ProjectBoardTask listTaskCommentsSubtasksTodos

Attributes

archived_at string
Response

Timestamp when this task list was archived, or null if active.
board board
Response

The folder (board) this task list belongs to.
board_id integer
Request Parameter `filter`

ID of the folder (board) this task list belongs to.
board_name object
Parameter `sort`

The name of the folder (board) this task list belongs to.
company_name object
Parameter `sort`

The name of the client company associated with the project this task list belongs to.
email_key string
Response

A unique key used to create tasks in this task list via email.
folder folder
Response

The folder this task list belongs to.
folder_id integer
Request Parameter `filter`

ID of the folder this task list belongs to.
folder_name object
Parameter `sort`

The name of the folder this task list belongs to.
id integer
Parameter `filter`

The unique identifier of this task list.
name string
Response Request

The name of this task list.
organization organization
Response

The organization this task list belongs to.
placement integer
Response

The display placement position of this task list within its folder.
position integer
Response Request

The sort position of this task list within its project.
project project
Response

The project this task list belongs to.
project_id integer
Request Parameter `filter`

ID of the project this task list belongs to.
project_name object
Parameter `sort`

The name of the project this task list belongs to.
query string
Parameter `filter`

A search query string used to filter task lists by name.
restorable string
Parameter `filter`

Whether this task list is restorable (archived while its parent folder is still active).
status integer
Parameter `filter` Enum

The archival status of this task list: active or archived.

Enum Values (2 values)

  • 1
  • 2

Operations

GET /api/v2/task_lists
Get task lists
POST /api/v2/task_lists
Create a task list
POST /api/v2/task_lists/copy
Copies a task list
GET /api/v2/task_lists/{id}
Gets a task list
PATCH /api/v2/task_lists/{id}
Update a task list
PATCH /api/v2/task_lists/{id}/archive
Archives a task list
PATCH /api/v2/task_lists/{id}/move
Moves a task list
PATCH /api/v2/task_lists/{id}/reposition
Repoisition a task list
PATCH /api/v2/task_lists/{id}/restore
Restores a task list