API Documentation
Task Lists ¶
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:
Supported filter params
-
id
-
project_id (array)
-
board_id (array)
-
status (active: 1, archived: 2)
Supported relationship filter params
-
board
-
project
GET /api/v2/task_lists?filter[project_id]=1364
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "318",
"type": "task_lists",
"attributes": {
"name": "task list name",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "8b31b0b4e4c8bbabb592516ecd102065"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1951"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/task_lists?filter%5Bproject_id%5D=1364&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/task_lists?filter%5Bproject_id%5D=1364&page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200
}
}
Get task listsGET/api/v2/task_lists
GET /api/v2/task_lists/321
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "321",
"type": "task_lists",
"attributes": {
"name": "task list name",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "acc61e707d165fc9cdf411eaa70d7de7"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1953"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/task_lists
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"name": "test name"
},
"relationships": {
"project": {
"data": {
"type": "projects",
"id": "1369"
}
},
"board": {
"data": {
"type": "boards",
"id": "338"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "323",
"type": "task_lists",
"attributes": {
"name": "test name",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "e6e3bcb06eb9e8b97c5e770997e69d29"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1954"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/task_lists
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/project"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/board"
}
}
]
}
Create a task listPOST/api/v2/task_lists
- name
string
(required) Example: Namename
- project_id
number
(required) Example: 1project id
- board_id
number
(required) Example: 1board id
PATCH /api/v2/task_lists/326
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"name": "new name"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "326",
"type": "task_lists",
"attributes": {
"name": "new name",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "0bdbcf2e17487c3b3e450fd3007e0070"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1958"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Update a task listPATCH/api/v2/task_lists/{id}
- id
number
(required) Example: 1task list id
PATCH /api/v2/task_lists/327/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "327",
"type": "task_lists",
"attributes": {
"name": "task list name",
"position": null,
"placement": null,
"archived_at": "2025-10-03T06:17:55.000+02:00",
"email_key": "46754f60fe0cc5b401cbe170026e2ff3"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1959"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Archives a task listPATCH/api/v2/task_lists/{id}/archive
- id
number
(required) Example: 1task list id
PATCH /api/v2/task_lists/328/restore
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "328",
"type": "task_lists",
"attributes": {
"name": "Milestone314",
"position": null,
"placement": 1010000,
"archived_at": null,
"email_key": "043964d4107e81285ba8f4e4c4e40b0c"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1960"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Restores a task listPATCH/api/v2/task_lists/{id}/restore
- id
number
(required) Example: 1task list id
POST /api/v2/task_lists/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"name": "copy task list",
"template_id": 329,
"project_id": 1375,
"board_id": 344,
"copy_open_tasks": true,
"copy_assignees": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "330",
"type": "task_lists",
"attributes": {
"name": "copy task list",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "cae759ef4b0bf15b653769e33e4e2835"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1961"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/task_lists/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"name": "copy task list",
"template_id": 331,
"project_id": 1377,
"board_id": 346,
"copy_open_tasks": true,
"copy_assignees": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "332",
"type": "task_lists",
"attributes": {
"name": "copy task list",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "d093da19e1ad0439b93e0acb0ec85cb1"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1962"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/task_lists/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"name": "copy task list",
"template_id": 333,
"project_id": 1379,
"board_id": 348,
"copy_open_tasks": true,
"copy_assignees": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "335",
"type": "task_lists",
"attributes": {
"name": "copy task list",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "f50ed92b353be103c616caca1f2e2543"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1963"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/task_lists/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"name": "copy task list",
"template_id": 336,
"project_id": 1382,
"board_id": 351,
"copy_open_tasks": true,
"copy_assignees": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "338",
"type": "task_lists",
"attributes": {
"name": "copy task list",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "b15757745d38d553ceb872c0f1f9d123"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1964"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Copies a task listPOST/api/v2/task_lists/copy
- id
number
(required) Example: 1task list id
PATCH /api/v2/task_lists/339/move
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"board_id": 354
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "339",
"type": "task_lists",
"attributes": {
"name": "task list name",
"position": null,
"placement": null,
"archived_at": null,
"email_key": "ecea502dc7f5f797777ea0c0d6b3c2b7"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1965"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/task_lists/340/move
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"board_id": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/board_id"
}
}
]
}
Moves a task listPATCH/api/v2/task_lists/{id}/move
- id
number
(required) Example: 1task list id
PATCH /api/v2/task_lists/341/reposition
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "task_lists",
"attributes": {
"move_before_id": 342
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "341",
"type": "task_lists",
"attributes": {
"name": "task list name",
"position": null,
"placement": 90000,
"archived_at": null,
"email_key": "f4201e0e8a76f2bb3215ef377d5e637e"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1967"
}
},
"project": {
"meta": {
"included": false
}
},
"board": {
"meta": {
"included": false
}
},
"folder": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Repoisition a task listPATCH/api/v2/task_lists/{id}/reposition
- id
number
(required) Example: 1task list id
Generated by aglio on 03 Oct 2025