API v1 ReferenceTask Lists

Archives or unarchives the task list with the specified id.

Archives or unarchives the task list with the specified id. An archived task list still exists but is not editable anymore. <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.
taskListIdstringRequiredformat: "uuid"
The id of the task list.

Request

The archived Task List form.
isArchivedbooleanRequired
Flags the entity as archived.
taskOperationstring or nullOptional

The operation for tasks which are not yet done. The operation is required if you set a list to archived. Can be: task-to-done: Set tasks to ‘Done’ or the first status of type ‘done’. task-remove: Remove tasks from this task list. task-move: Move tasks to another list. task-delete: Deletes the non done tasks.

taskListIdstring or nullOptionalformat: "uuid"

The id of the task list where all non done tasks should moved to. Only necessary if TaskOperation is set to ‘task-move’.

deleteTimeTrackingsboolean or nullOptional

Set to true to delete also the related time trackings of all non done tasks. Only necessary if TaskOperation is set to ‘task-delete’.

Response

OK
idstring or nullformat: "uuid"
The id of the task list.
createdOndatetime or null
The date this task list was created.
createdBystring or nullformat: "uuid"
The id of the user who created this task list.
updatedOndatetime or null
The date this task list was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this task list.
namestring or null
The name of the list.
orderdouble or null
The order of the list.
plannedDurationinteger or null
The planned duration for this task list, in seconds.
totalPlannedDurationlong or null

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 null

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.

isArchivedboolean or null
Whether the task list has been archived.
isHiddenForConnectUsersboolean or null
True if the task in this list will be not visible for external workspace users. False otherwise.
trackedDurationinteger or null

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