GET/projects/api/v3/projects/{projectId}/tasklists
Get tasklists in a project
Path Params
- Name
projectId
- Type
- integer
- required
- Description
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
- Allowed values
asc
desc
- Name
orderBy
- Type
- string
- Description
order by
- Default
displayorder
- Allowed values
displayorder
name
status
createdat
updatedat
project
- 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
- Default
50
- Name
page
- Type
- integer
- Description
page number
- 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
projects.permissions
projects.integrations
milestones
defaultCustomfields
defaultCustomfieldTasks
defaultColumns
defaultWorkflowStages
defaultWorkflows
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[tasks]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
name
dateUpdated
parentTaskId
isPrivate
status
tasklistId
startDate
dueDate
- Name
fields[tasklists]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
name
projectId
milestoneId
- 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[projectIntegrations]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
userId
projectId
canAccessBox
canAccessDropbox
canAccessGoogleDocs
canAccessOneDrive
canAccessOneDriveBusiness
canAccessSharePoint
- 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
- Name
fields[ProjectPermissions]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
viewMessagesAndFiles
viewTasksAndMilestones
viewTime
viewNotebooks
viewRiskRegister
viewEstimatedTime
viewInvoices
addTasks
addRisks
manageCustomFields
addExpenses
editAllTasks
addMilestones
addTaskLists
addMessages
addFiles
addTime
addNotebooks
viewLinks
addLinks
canViewForms
addForms
viewAllTimeLogs
setPrivacy
projectAdministrator
viewProjectUpdate
addProjectUpdate
canViewProjectMembers
canViewProjectBudget
canManageProjectBudget
canViewRates
canManageRates
canViewSchedule
canManageSchedule
receiveEmailNotifications
isObserving
isArchived
active
canAccess
inOwnerCompany
canManagePeople
canViewProjectTemplates
canManageProjectTemplates
- Name
excludeIds
- Type
- array[integer]
- Description
Exclude certain tasklists from the response
- Default
nil
- Format
- Comma separated values
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.
- Code
- 403
- Type
- object
- Schema
- Description
- 403 Forbidden
ErrorResponse defines how []Error should be marshaled to JSON.
200 OK
TasklistsResponse
{ "included": { "ProjectPermissions": { "additionalProp": { "active": true, "addExpenses": true, "addFiles": true, "addForms": true, "addLinks": true, "addMessages": true, "addMilestones": true, "addNotebooks": true, "addProjectUpdate": true, "addRisks": true, "addTaskLists": true, "addTasks": true, "addTime": true, "canAccess": true,