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 project 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. In cases where the user tries to get the private task lists, permissions are not necessary.

Path parameters

projectIdUUIDRequired

The id of the project.

Headers

AuthorizationstringRequired

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

Query parameters

showArchivedbooleanOptionalDefaults to false

Include archived task lists in the results. Not required. False by default.

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

idUUIDOptional

The id of the task list.

isArchivedbooleanOptional

Whether the task list has been archived.

createdOndatetimeOptional

The date this task list was created.

createdByUUIDOptional

The id of the user who created this task list.

updatedOndatetimeOptional

The date this task list was last modified.

updatedByUUIDOptional

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.

isHiddenForConnectUsersbooleanOptional

True if the task in this list will be not visible for external workspace users. False otherwise.