Folders

The Folder object represents a folder within the project management system. It sits between Projects and Task lists, meaning it belongs to a project and contains multiple task lists.

You can find out more about folders in our Help documentation: Folders

Following diagram shows folders in our data hierarchy:

ProjectFolderTask listTaskCommentsSubtasksTodos

Attributes

archived_at string
Response

The timestamp when this folder was archived, or null if the folder is active.

hidden boolean
Response Request

Whether this folder is hidden from the project view.

id integer
Parameter `filter`

The unique identifier of this folder.

name string
Response Request

The display name of this folder.

organization organization
Response

The organization this folder belongs to.

placement integer
Response

The fractional index used for ordering folders within a project, managed by the reposition endpoint.

position integer
Response Request

The integer sort position of this folder within its project.

project project
Response

The project this folder belongs to.

project_id integer
Request Parameter `filter`

The ID of the project this folder belongs to.

query string
Parameter `filter`

The name of this folder, used as a search query field in filter operations.

status integer
Parameter `filter` Enum

The archive status of this folder. Returns 1 for active folders and 2 for archived folders.

Enum Values (2 values)

  • 1
  • 2