GET/tasklists.json

Get all Task Lists

This will return all task lists on your site across all projects.

Query Params

  • Name
    status
    Type
    string
    Description

    You can use the status option to restrict the Task Lists returned

    Default
    active
    Allowed values
    • all
    • active
    • completed
  • Name
    page
    Type
    string
    Description

    Page number, This is usually used in conjunction with the parameter pageSize.

    See How does paging work for more detailed documentation on pagination.

    Default
    1
  • Name
    pageSize
    Type
    string
    Description

    Minimum: 1 Maximum: 250

    Default
    250
  • Name
    showDeleted
    Type
    boolean
    Description
    Default
    false
  • Name
    includeArchivedProjects
    Type
    boolean
    Description
    Default
    false

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "STATUS": "OK",
  "tasklists": [
    {
      "id": "1",
      "name": "task list 1",
      "description": "",
      "position": 1,
      "projectId": "1",
      "projectName": "My testing project",
      "updatedAfter": "2018-09-13T14:57:03Z",
      "private": false,
      "isTemplate": false,
      "tags": [],
      "milestone-id": "",
      "pinned": false,
      "complete": false,
      "uncompleted-count": 17,
      "status": "new"
    }
  ]
}