Get all subtasks for a specific task.
Return multiple subtasks according to the provided filter.
On this endpoint you can filter by custom fields. The syntax for the query parameter is the following:
customField[id][op]=value
Where:
- [id] is the custom field ID
- [op] is the operator to apply when filtering, different operators are allowed according to the custom field type
- [value] is the value to apply when filtering
For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following:
customField[10][eq]=Option1
The allowed operators are:
- like
- not-like
- eq
- not
- lt
- gt
- any
Path Params
- Name
taskId- Type
- integer
- required
- Description
Query Params
- Name
updatedBefore- Type
- string
- Description
filter by updated before date
- Name
updatedAfter- Type
- string
- Description
filter by updated after date
- Name
today- Type
- string
- Description
filter by today
- Name
taskFilter- Type
- string
- Description
filter by a taskFilter
- Allowed values
allanytimecompletedcreatedoverduetodayyesterdaystartedtomorrowthisweekwithin7within14within30within365nodatenoduedatenostartdatenewTaskDefaultshasDate
- Name
startDate- Type
- string
- Description
filter on start date
- Name
searchTerm- Type
- string
- Description
filter by search term
- Name
reportType- Type
- string
- Description
define the type of the report
- Default
task- Allowed values
plannedvsactualtasktasktime
- Name
reportFormat- Type
- string
- Description
define the format of the report
- Default
pdf- Allowed values
htmlpdf
- Name
priority- Type
- string
- Description
filter by task priority
- Name
orderMode- Type
- string
- Description
order mode
- Default
asc- Allowed values
ascdesc
- Name
orderBy- Type
- string
- Description
order by
- Default
duedate- Allowed values
startdatecreatedatpriorityprojectflattenedtasklistcompanymanualactivecompletedatduestartdatealldatestasklistnametasklistdisplayordertasklistidduedateupdatedattasknamecreatedbycompletedbyassignedtotaskstatustaskduedatecustomfieldestimatedtimeboardcolumntaskgroupidtaskgroupnametaskgroupdisplayorderprojectmanualstagedisplayorderstage
- Name
notCompletedBefore- Type
- string
- Description
filter by projects that have not been completed before the given date
- Name
endDate- Type
- string
- Description
filter on end date
- Name
dueBefore- Type
- string
- Description
filter before a due date
- Name
dueAfter- Type
- string
- Description
filter after a due date
- Name
deletedAfter- Type
- string
- Description
filter on deleted after date
- Name
createdFilter- Type
- string
- Description
filter by created filter
- Allowed values
anytimetodayyesterdaycustom
- Name
createdDateCode- Type
- string
- Description
filter by created date code
- Name
createdBefore- Type
- string
- Description
filter by created before date
- Name
createdAfter- Type
- string
- Description
filter by created after date
- Name
completedBefore- Type
- string
- Description
filter by completed before date
- Name
completedAfter- Type
- string
- Description
filter by completed after date
- Name
updatedByUserId- Type
- integer
- Description
filter by updated user id
- Name
parentTaskId- Type
- integer
- Description
filter by parent task ids
- Name
pageSize- Type
- integer
- Description
number of items in a page
- Default
50
- Name
page- Type
- integer
- Description
page number
- Default
1
- Name
orderByCustomFieldId- Type
- integer
- Description
order by custom field id when orderBy is equal to customfield
- Name
includeTaskId- Type
- integer
- Description
include task id
- Name
filterId- Type
- integer
- Description
provide a user saved filter ID
- Name
completedByUserId- Type
- integer
- Description
filter by completed user id
- Name
useTaskDateRange- Type
- boolean
- Description
use daterange logic from table when getting the tasks
- Default
false
- Name
useStartDatesForTodaysTasks- Type
- boolean
- Description
use start dates for todays tasks
- Name
useFormulaFields- Type
- boolean
- Description
use formula fields
- Name
useAllProjects- Type
- boolean
- Description
filter on all projects
- Name
sortActiveFirst- Type
- boolean
- Description
sort active tasks first
- Default
false
- Name
skipCounts- Type
- boolean
- Description
SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
- Name
showDeleted- Type
- boolean
- Description
include deleted items
- Default
false
- Name
showCompletedLists- Type
- boolean
- Description
include tasks from completed lists
- Name
searchCompaniesTeams- Type
- boolean
- Description
include companies and teams in the search term
- Name
searchAssignees- Type
- boolean
- Description
include assignees in the search
- Name
onlyUntaggedTasks- Type
- boolean
- Description
only untagged tasks
- Name
onlyUnplanned- Type
- boolean
- Description
only return tasks that are unplanned. Not assigned, no due date or missing estimated time.
- Default
false
- Name
onlyTasksWithUnreadComments- Type
- boolean
- Description
filter by only tasks with unread comments
- Name
onlyTasksWithTickets- Type
- boolean
- Description
filter by only tasks with tickets
- Name
onlyTasksWithEstimatedTime- Type
- boolean
- Description
only return tasks with estimated time
- Name
onlyStarredProjects- Type
- boolean
- Description
filter by starred projects only
- Name
onlyAdminProjects- Type
- boolean
- Description
only include tasks from projects where the user is strictly a project admin. site admins have visibility to all projects.
- Name
nestSubTasks- Type
- boolean
- Description
nest sub tasks
- Name
matchAllTags- Type
- boolean
- Description
match all tags
- Name
matchAllProjectTags- Type
- boolean
- Description
match all project tags
- Name
matchAllExcludedTags- Type
- boolean
- Description
match all exclude tags
- Name
isReportDownload- Type
- boolean
- Description
generate a report export.
- Default
false
- Name
includeUpdate- Type
- boolean
- Description
include tasks latest update action
- Name
includeUntaggedTasks- Type
- boolean
- Description
include untagged tasks
- Name
includeTomorrow- Type
- boolean
- Description
filter by include tomorrow
- Name
includeToday- Type
- boolean
- Description
filter by include today
- Name
includeTeamUserIds- Type
- boolean
- Description
include members of the given teams
- Name
includeTasksWithoutDueDates- Type
- boolean
- Description
include tasks without due dates
- Name
includeTasksWithCards- Type
- boolean
- Description
include tasks with cards
- Default
true
- Name
includeTasksFromDeletedLists- Type
- boolean
- Description
include tasks from deleted lists
- Name
includeTasksCount- Type
- boolean
- Description
include total count of tasks for given filter
- Default
false
- Name
includeRelatedTasks- Type
- boolean
- Description
include ids of active subtasks, dependencies, predecessors
- Name
includePrivateItems- Type
- boolean
- Description
include private items
- Name
includeOverdueTasks- Type
- boolean
- Description
include overdue tasks
- Name
includeOriginalDueDate- Type
- boolean
- Description
include original due date of a task
- Name
includeCustomFields- Type
- boolean
- Description
include custom fields
- Default
false
- Name
includeCompletedTasks- Type
- boolean
- Description
include completed tasks
- Name
includeCompletedPredecessors- Type
- boolean
- Description
include ids of completed predecessors. It must be provided with includeRelatedTasks flag or with the predecessors sideload.
- Name
includeCompanyUserIds- Type
- boolean
- Description
include members of the given companies
- Name
includeCommentStats- Type
- boolean
- Description
include number of unread and read comments for each task
- Default
false
- Name
includeBlocked- Type
- boolean
- Description
filter by include blocked
- Name
includeAttachmentCommentStats- Type
- boolean
- Description
include number of unread and read comments for each file attachment
- Default
false
- Name
includeAssigneeTeams- Type
- boolean
- Description
include teams related to the responsible user ids
- Name
includeAssigneeCompanies- Type
- boolean
- Description
include companies related to the responsible user ids
- Name
includeArchivedProjects- Type
- boolean
- Description
include archived projects
- Name
includeAllComments- Type
- boolean
- Description
include all comments
- Name
groupByTasklist- Type
- boolean
- Description
group by tasklist
- Name
groupByTaskgroup- Type
- boolean
- Description
group by taskgroup
- Name
getSubTasks- Type
- boolean
- Description
get sub tasks
- Name
getFiles- Type
- boolean
- Description
get files
- Name
fallbackToMilestoneDueDate- Type
- boolean
- Description
set due date as milestone due date if due date is null and there's a related milestone
- Name
extractTemplateRoleName- Type
- boolean
- Description
For tasks created in a project template it's possible to assign a role instead of people, companies or teams. This role is then stored with the task name as a prefix. When this flag is enabled it will extract the role name and return it inside a special field.
- Name
excludeAssigneeNotOnProjectTeams- Type
- boolean
- Description
exclude assignee not on project teams
- Name
deletedOnly- Type
- boolean
- Description
only deleted tasks
- Default
false
- Name
completedOnly- Type
- boolean
- Description
only completed tasks
- Default
false
- Name
checkForReminders- Type
- boolean
- Description
check if task has reminders
- Name
calculateTasklistDates- Type
- boolean
- Description
calculate task list start and due dates from earliest and latest tasks
- Name
allowAssigneesOutsideProject- Type
- boolean
- Description
when filtering by assigned or unassagned tasks, include assignees that are not in the project.
- Default
true
- Name
tasksSelectedColumns- Type
- array[string]
- Description
customise the report by selecting columns to be displayed for tasks report
- Format
- Comma separated values
- Name
tasklistIds- Type
- array[integer]
- Description
filter by tasklist ids
- Format
- Comma separated values
- Name
taskgroupIds- Type
- array[integer]
- Description
filter by taskgroup ids
- Format
- Comma separated values
- Name
taskIncludedSet- Type
- array[string]
- Description
filter by task included set
- Format
- Comma separated values
- Allowed values
overduenodatenostartdatenoduedatenostartwithfutureduedatetaskListNamesprojectNames
- Name
tags- Type
- array[string]
- Description
filter by tag values
- Format
- Comma separated values
- Name
tagIds- Type
- array[integer]
- Description
filter by tag ids
- Format
- Comma separated values
- Name
status- Type
- array[string]
- Description
filter by list of task status
- Format
- Comma separated values
- Allowed values
upcominglateall
- Name
skipCRMDealIds- Type
- array[integer]
- Description
skip crm deal ids
- Format
- Comma separated values
- Name
selectedColumns- Type
- array[string]
- Description
customise the report by selecting columns to be displayed for planned vs actual.
- Format
- Comma separated values
- Name
responsiblePartyIds- Type
- array[integer]
- Description
filter by responsible party ids
- Format
- Comma separated values
- Name
projectTagIds- Type
- array[integer]
- Description
filter by project tag ids
- Format
- Comma separated values
- Name
projectStatuses- Type
- array[string]
- Description
filter by project status
- Format
- Comma separated values
- Allowed values
activecurrentlateupcomingcompleteddeleted
- Name
projectOwnerIds- Type
- array[integer]
- Description
filter by project owner ids
- Format
- Comma separated values
- Name
projectIds- Type
- array[integer]
- Description
filter by project ids
- Format
- Comma separated values
- Name
projectHealths- Type
- array[integer]
- Description
filter by project healths
0: not set 1: bad 2: ok 3: good
- Format
- Comma separated values
- Allowed values
0123
- Name
projectFeaturesEnabled- Type
- array[string]
- Description
filter by projects that have features enabled
- Format
- Comma separated values
- Allowed values
listboardgantttabledashboardmilestonesmessagesfilestimenotebooksriskslinksbillingcommentspeoplesettings
- Name
projectCompanyIds- Type
- array[integer]
- Description
filter by company ids
- Format
- Comma separated values
- Name
projectCategoryIds- Type
- array[integer]
- Description
filter by project category ids
- Format
- Comma separated values
- Name
portfolioBoardIds- Type
- array[integer]
- Description
filter by portfolio board ids
- Format
- Comma separated values
- Name
includeCustomFieldIds- Type
- array[integer]
- Description
include specific custom fields
- Format
- Comma separated values
- Name
include- Type
- array[string]
- Description
include (permissions deprecated, use projects.permissions)
- Format
- Comma separated values
- Allowed values
projectsprojects.companiesprojects.categoriesprojects.permissionsprojects.integrationstasklistsparentTaskscompaniesteamsusersmilestonescommentscomments.userstagscardscards.columnstimeTotalstaskSequencescommentFollowerschangeFollowerscompleteFollowerslockdownslockdowns.userslockdowns.companieslockdowns.teamslockdowns.users.companieslockdowns.companies.userslockdowns.teams.usersattachmentsattachments.userssubtaskStatstimerspredecessorspermissions
- Name
ids- Type
- array[integer]
- Description
filter by task ids
- Format
- Comma separated values
- Name
followedByUserIds- Type
- array[integer]
- Description
filter by followed by user ids
- Format
- Comma separated values
- Name
filterBoardColumnIds- Type
- array[integer]
- Description
filter by board column ids
- Format
- Comma separated values
- Name
fields[workflows]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnamestatusId
- Name
fields[users]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idfirstNamelastNametitleemailcompanyIdcompanyisAdminisClientUserisServiceAccounttypedeletedavatarUrllengthOfDayworkingHoursIdworkingHouruserRateuserCostcanAddProjects
- Name
fields[timers]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
iduserIdtaskIdprojectIddescriptionrunningbillabledeleteddateCreateddateDeleteddurationlastStartedAtserverTimeintervals
- Name
fields[teams]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnameteamLogoteamLogoIconteamLogoColor
- Name
fields[tasks]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnamedateUpdatedparentTaskIdisPrivatestatustasklistIdstartDatedueDate
- Name
fields[tasklists]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnameprojectIdmilestoneId
- Name
fields[taskgroups]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnamedescriptiondisplayOrderprojectIdstatus
- Name
fields[taskSequences]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idinstallationIdfrequencyselectedWeekDaysendDatemonthlyRepeatTypedurationrrule
- Name
fields[tags]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnamecolorcount
- Name
fields[stages]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnamestage
- Name
fields[projects]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idname
- Name
fields[projectIntegrations]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
userIdprojectIdcanAccessBoxcanAccessDropboxcanAccessGoogleDocscanAccessOneDrivecanAccessOneDriveBusinesscanAccessSharePoint
- Name
fields[milestones]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnamedescriptiondeadlinecompletedprojectIdcreatedOnlastChangedOncreatorUserIdreminderprivatelockdownIdstatuscompletedOncompleterIdpercentageComplete
- Name
fields[lockdowns]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
iduserIDupdatedAtitemTypeitemIDgrantAccessTo
- Name
fields[groups]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
latetodaytomorrowlater-this-weeknext-weeklaterno-due-date
- Name
fields[files]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
isPrivatelatestFileVersionNoversionIdstatusdescriptionlockdownIdtagIdschangeFollowerscommentFollowersoriginalNamedisplayNameisLockedlockedByUserIdlockedDatesizeuploadedDateuploadedByUserIDupdatedAtdeletedAtdeletedByfileSourceprojectIdnumLikesreactionsversionsdownloadURLpreviewURLthumbURLrelatedItemscommentsCountcommentsCountReadcategoryId
- Name
fields[customfields]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idprojectIdentitynamedescriptiontypeoptionsvisibilitiesisPrivaterequiredcreatedAtcreatedByUserIdupdatedAtupdatedByUserIddeleteddeletedAtdeletedByUserId
- Name
fields[customfieldTasks]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idcustomfieldIdvaluecreatedAtcreatedBy
- Name
fields[companies]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnamelogoUploadedToServerlogoImage
- Name
fields[comments]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idobjectTypeobjectIdtitle
- Name
fields[columns]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
idnamecolordisplayOrdercreatedAtupdatedAtsettingssortsortOrderdeletedAtprojecthasTriggersdeletedstatsdefaultTasklist
- Name
fields[cards]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
iddisplayOrderarchivedarchivedAtarchivedBycreatedAtcreateByupdatedAtvisiblestatusdeleteBydeletedAt
- Name
fields[ProjectPermissions]- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
viewMessagesAndFilesviewTasksAndMilestonesviewTimeviewNotebooksviewRiskRegisterviewEstimatedTimeviewInvoicesaddTasksaddRisksmanageCustomFieldsaddExpenseseditAllTasksaddMilestonesaddTaskListsaddMessagesaddFilesaddTimeaddNotebooksviewLinksaddLinkscanViewFormsaddFormsviewAllTimeLogssetPrivacyprojectAdministratorviewProjectUpdateaddProjectUpdatecanViewProjectMemberscanViewProjectBudgetcanManageProjectBudgetcanViewRatescanManageRatescanViewSchedulecanManageSchedulereceiveEmailNotificationsisObservingisArchivedactivecanAccessinOwnerCompanycanManagePeoplecanViewProjectTemplatescanManageProjectTemplates
- Name
expandedIds- Type
- array[integer]
- Description
the ids of the expanded tasks
- Format
- Comma separated values
- Name
excludeTagIds- Type
- array[integer]
- Description
filter by excluded tag ids
- Format
- Comma separated values
- Name
crmDealIds- Type
- array[integer]
- Description
filter by crm deal ids
- Format
- Comma separated values
- Name
createdByUserIds- Type
- array[integer]
- Description
filter by creator user ids
- Format
- Comma separated values
- Name
assigneeTeamIds- Type
- array[integer]
- Description
filter by assignee team ids
- Format
- Comma separated values
- Name
assigneeCompanyIds- Type
- array[integer]
- Description
filter by assignee company ids
- Format
- Comma separated values
- Name
CustomFields- Type
- array[string]
- Description
filter by custom fields
- Format
- Comma separated values
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
200 OK
{ "included": { "cards": { "additionalProp": { "archived": true, "archivedAt": "string", "archivedBy": { "id": 0, "meta": {}, "type": "string" }, "column": { "id": 0, "meta": {}, "type": "string" }, "createBy": { "id": 0,