API v1 ReferenceTask Lists

Returns all task lists of the project with the specified id.

The permission check in this function is dynamically based on the entity name. In the cases where the user tries to get the project task lists, the user needs read permissions on the project-planning-data feature. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"
The id of the project.

Query parameters

showArchivedbooleanOptionalDefaults to false
The show Archived.
pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
idstringOptionalformat: "uuid"
The id of the task list.
createdOnstringOptionalformat: "date-time"
The date this task list was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this task list.
updatedOnstringOptionalformat: "date-time"
The date this task list was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this task list.
namestring or nullOptional
The name of the list.
orderdouble or nullOptional
The order of the list.
plannedDurationinteger or nullOptional
The planned duration for this task list, in seconds.
totalPlannedDurationlong or nullOptional

The total planned duration for this task list, including all primary tasks (parent tasks which have this tacklist as PrimaryTaskListId), in seconds. Calculated: sum PlannedDuration of primary tasks in list Archived task lists are not included in the calculation.

totalPlannedDurationWithHierarchylong or nullOptional

The total planned duration for this task list, including all primary tasks (parent tasks which have this task list as PrimaryTaskListId), in seconds. Calculated: max(PlannedDuration, sum TotalPlannedDurationWithHierarchy of primary tasks in list) Archived task lists are not included in the calculation.

isArchivedbooleanOptional
Whether the task list has been archived.
isHiddenForConnectUsersbooleanOptional
True if the task in this list will be not visible for external workspace users. False otherwise.
trackedDurationintegerOptional

The total duration of time trackings for tasks in this task list, in seconds. Includes both billable and non-billable time trackings. Backend-calculated property. When hierarchy feature flag is enabled: only tasks with PrimaryTaskListId == this list. When hierarchy feature flag is disabled: all tasks associated with this list.

Errors

401
Unauthorized Error