Back to TeamworkGet all tasklists
Input
type: object
properties:
parameters:
type: object
properties:
updatedAfter:
type: string
format: date-time
description: filter by updated after date
searchTerm:
type: string
description: filter by search term
projectType:
type: string
description: filter by project type
orderMode:
type: string
enum:
- asc
- desc
default: asc
description: order mode
orderBy:
type: string
enum:
- displayorder
- name
- status
- createdat
- updatedat
- project
default: displayorder
description: order by
projectBudgetId:
type: integer
default: nil
description: |-
filter the task list budget by its parent project budget id, if none
is provided it weill default to the current active budget.
pageSize:
type: integer
default: '50'
description: number of items in a page
page:
type: integer
default: '1'
description: page number
showPrivate:
type: boolean
default: 'true'
description: include private items
showDeleted:
type: boolean
default: 'false'
description: include deleted items
showCompleted:
type: boolean
default: 'false'
description: include completed items
isReportDownload:
type: boolean
default: 'false'
description: >-
this means use the tasklist report endpoint, which has totally
different query params
includeArchivedProjects:
type: boolean
description: include archived projects
completedOnly:
type: boolean
default: 'false'
description: include only completed items
projectIds:
type: array
items:
type: integer
description: filter by project ids
include:
type: array
items:
enum:
- defaultTasks
- defaultTasks.users
- defaultTasks.teams
- defaultTasks.companies
- createdBy
- updatedBy
- companies
- projects
- milestones
- defaultCustomfields
- defaultCustomfieldTasks
- defaultColumns
- lockdowns
- lockdowns.users
- lockdowns.companies
- lockdowns.teams
- lockdowns.users.companies
- lockdowns.companies.users
- lockdowns.teams.users
type: string
description: include
ids:
type: array
items:
type: integer
description: filter by ids
fields[users]:
type: array
items:
enum:
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
type: string
fields[teams]:
type: array
items:
enum:
- id
- name
- teamLogo
- teamLogoIcon
- teamLogoColor
type: string
fields[tags]:
type: array
items:
enum:
- id
- name
- color
- count
type: string
fields[projects]:
type: array
items:
enum:
- id
- name
type: string
fields[milestones]:
type: array
items:
enum:
- id
- name
- description
- deadline
- completed
- projectId
- createdOn
- lastChangedOn
- creatorUserId
- reminder
- private
- lockdownId
- status
- completedOn
- completerId
- percentageComplete
type: string
fields[lockdowns]:
type: array
items:
enum:
- id
- userID
- updatedAt
- itemType
- itemID
- grantAccessTo
type: string
fields[companies]:
type: array
items:
enum:
- id
- name
- logoUploadedToServer
- logoImage
type: string
title: Parameters
Output
type: object
title: TasklistsResponse
properties:
included:
type: object
properties:
columns:
type: object
companies:
type: object
customfieldTasks:
type: object
customfields:
type: object
lockdowns:
type: object
milestones:
type: object
notifications:
type: object
projects:
type: object
tasklistBudgets:
type: object
tasklistTaskStats:
type: object
tasks:
type: object
teams:
type: object
users:
type: object
meta:
type: object
title: Meta
properties:
averageSpend:
type: integer
limit:
type: integer
nextCursor:
type: string
page:
type: object
title: MetaPage
properties:
count:
type: integer
hasMore:
type: boolean
pageOffset:
type: integer
pageSize:
type: integer
prevCursor:
type: string
totalCapacity:
type: integer
tasklists:
type: array
items:
type: object
title: Tasklist
properties:
createdAt:
type: string
defaultTask:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
defaultTaskId:
type: integer
description:
type: string
displayOrder:
type: integer
icon:
type: string
id:
type: integer
isBillable:
type: boolean
isPinned:
type: boolean
isPrivate:
type: boolean
lockdownId:
type: integer
milestone:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
milestoneId:
type: integer
name:
type: string
project:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
projectId:
type: integer
status:
type: string
tasklistBudget:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
updatedAt:
type: string