CLclickup
Folders

Get Folder

Changed on

View the Lists within a Folder. If the Folder is a subfolder, the response includes a parent_folder field with the parent Folder ID.

Use the include_subfolders query parameter to include a folders array in the response. Each entry is a complete Folder object with the same fields as the Folder you requested, including its own folders array, so the response contains the whole subfolder tree down to the Workspace's subfolder nesting limit. Subfolders the requesting user cannot access are excluded.

get/v2/folder/{folder_id}

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/folder/{folder_id}
  • Auth
    API key in header Authorization

Path parameters

folder_idnumber required
Example:457

Query parameters

include_subfoldersboolean

Set to true to include the nested subfolder tree in the response as a folders array of complete Folder objects. Subfolder support must be enabled for the Workspace.

Response

idstring required
namestring required
orderindexinteger required
override_statusesboolean required
hiddenboolean required
spaceSpace required(unresolved $ref)
task_countstring required
archivedboolean

Whether the Folder is archived.

permission_levelstring

The requesting user's permission level on this Folder (read, comment, edit, or create).

listsstring[] required
parent_folderstring

ID of the parent Folder if this Folder is a subfolder. Only present when the Folder is nested inside another Folder.

Example response

{
  "id": "457",
  "name": "Updated Folder Name",
  "orderindex": 0,
  "override_statuses": false,
  "hidden": false,
  "space": {
    "id": "789",
    "name": "Space Name",
    "access": true
  },
  "task_count": "0",
  "statuses": [
    {
      "id": "p789_87Rq2Yzk",
      "status": "to do",
      "orderindex": 0,
      "color": "#87909e",
      "type": "open"
    }
  ],
  "lists": []
}

Changes

  • a0a72ec97ddbRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the new optional query request parameter include_subfolders

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status