GET/projects/api/v3/tasklists

Get all tasklists

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after date

  • Name
    searchTerm
    Type
    string
    Description

    filter by search term

  • Name
    projectType
    Type
    string
    Description

    filter by project type

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    displayorder
  • Name
    projectBudgetId
    Type
    integer
    Description

    filter the task list budget by its parent project budget id, if none is provided it weill default to the current active budget.

    Default
    nil
  • Name
    pageSize
    Type
    integer
    Description

    Number of items in a page See How does paging work for more detailed documentation on pagination. Minimum: 1 Maximum: 500

    Default
    50
  • Name
    page
    Type
    integer
    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
    useFormulaFields
    Type
    boolean
    Description

    use formula fields

  • Name
    sortActiveListsFirst
    Type
    boolean
    Description

    sort active lists first

    Default
    false
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    showPrivate
    Type
    boolean
    Description

    include private items

    Default
    true
  • Name
    showDeleted
    Type
    boolean
    Description

    include deleted items

    Default
    false
  • Name
    showCompleted
    Type
    boolean
    Description

    include completed items

    Default
    false
  • Name
    isReportDownload
    Type
    boolean
    Description

    this means use the tasklist report endpoint, which has totally different query params

    Default
    false
  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

  • Name
    getEmptyLists
    Type
    boolean
    Description

    include empty lists

    Default
    true
  • Name
    completedOnly
    Type
    boolean
    Description

    include only completed items

    Default
    false
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    projectCompanyIds
    Type
    array[integer]
    Description

    filter by project company ids

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • defaultTasks
    • defaultTasks.users
    • defaultTasks.teams
    • defaultTasks.reminders
    • defaultTasks.customfields
    • defaultTasks.companies
    • createdBy
    • updatedBy
    • companies
    • projects
    • milestones
    • defaultCustomfields
    • defaultCustomfieldTasks
    • defaultColumns
    • defaultWorkflowStage
    • lockdowns
    • lockdowns.users
    • lockdowns.companies
    • lockdowns.teams
    • lockdowns.users.companies
    • lockdowns.companies.users
    • lockdowns.teams.users
  • Name
    ids
    Type
    array[integer]
    Description

    filter by ids

    Format
    Comma separated values
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[teams]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • teamLogo
    • teamLogoIcon
    • teamLogoColor
  • Name
    fields[tags]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • color
    • count
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[milestones]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • description
    • deadline
    • completed
    • projectId
    • createdOn
    • lastChangedOn
    • creatorUserId
    • reminder
    • private
    • lockdownId
    • status
    • completedOn
    • completerId
    • percentageComplete
  • Name
    fields[lockdowns]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • userID
    • updatedAt
    • itemType
    • itemID
    • grantAccessTo
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    TasklistsResponse contains information about a group of tasklists.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

TasklistsResponse
{  "included": {    "columns": {      "additionalProp": {        "color": "string",        "createdAt": "string",        "defaultTasklist": {          "id": 0,          "meta": {},          "type": "string"        },        "deleted": true,        "deletedAt": "string",        "displayOrder": 0,        "hasTriggers": true,        "id": 0,        "name": "string",        "project": {