Skip to content

Todolists

Get all todolists

Section titled “ Get all todolists ”
GET v3/projects/23423233/todolists returns all todolists for the specified project. 
[
  {
    "id": 13964085,
    "title": "Training material on technology and its use in IT sector",
    "private": false,
    "archived": false,
    "completed_count": 0,
    "remaining_count": 8,
    "time_tracking": false,
    "show_in_gantt": false,
    "assigned": [12009183],
    "associate_milestone": false,
    "project": {
      "id": 23423233
    },
    "creator": {
      "id": 12009183
    }
  },
  {
    "id": 13965645,
    "title": "Training material on marketing",
    "private": false,
    "archived": false,
    "completed_count": 2,
    "remaining_count": 0,
    "time_tracking": true,
    "show_in_gantt": true,
    "project": {
      "id": 23423233
    }
  }
]

The response may also include workflow information, custom fields, milestones, timesheets, and assignment details.

Get todolist

Section titled “ Get todolist ”
GET v3/projects/23423233/todolists/13964085 returns the specified todolist.

This endpoint also returns any custom fields configured on the todolist. 

{
  "id": 13964085,
  "title": "Training material on technology and its use in IT sector",
  "private": false,
  "archived": false,
  "completed_count": 0,
  "remaining_count": 8,
  "time_tracking": false,
  "show_in_gantt": false,
  "assigned": [12009183],
  "workflow": {
    "id": 8767866337,
    "name": "Flow of work"
  },
  "custom_fields": [
    {
      "id": 76672841,
      "title": "Tags",
      "type": "Tags"
    },
    {
      "id": 847596409,
      "title": "% Mark",
      "type": "Percentage"
    },
    {
      "id": 948440684,
      "title": "Drop Down Selection",
      "type": "Dropdown"
    }
  ]
}

Create todolist

Section titled “ Create todolist ”
POST v3/projects/23423233/todolists creates a new todolist. 
{
  "title": "Proposal for campaign",
  "private": false,
  "time_tracking": false,
  "show_in_gantt": true,
  "assigned": [
    12009183
  ]
}

The assigned array accepts People IDs.

Custom fields cannot be created through the API.

201 Created is returned along with the created todolist.

Update todolist

Section titled “ Update todolist ”
PUT v3/projects/23423233/todolists/13964085 updates the specified todolist. 
{
  "title": "Proposal for campaign",
  "private": true
}

Custom fields cannot be updated through the API.

200 OK is returned along with the updated todolist.

Delete todolist

Section titled “ Delete todolist ”
DELETE v3/projects/23423233/todolists/13964085 deletes the specified todolist.
204 No Content is returned if the todolist is deleted successfully. 403 Forbidden is returned if access is denied.

Copy todolist

Section titled “ Copy todolist ”
POST v3/projects/23423233/todolists creates a duplicate copy of an existing todolist. 
{
  "title": "Copy of second",
  "project": 145454545,
  "copy_stages": true,
  "copy_assignees": true,
  "copy_dates": true,
  "copy_comments": true,
  "copy_list": 13964085
}

Todolists can be copied within the same project or into another project.

201 Created is returned along with the copied todolist.

Move todolist

Section titled “ Move todolist ”
PUT v3/projects/23423233/todolists/13964085 moves an existing todolist to another project. 
{
  "title": "Copy of second",
  "project": 145454545,
  "move_stages": true,
  "move_people": true,
  "move_dates": true,
  "proof_comment": true,
  "id": 13964085,
  "move_list": true
}

Moving a todolist can optionally move stages, assignments, dates, and related comments.

200 OK is returned if the todolist is moved successfully. 403 Forbidden is returned if access is denied.