CLclickup
Folders

Create Folder

Changed on

Add a new Folder to a Space. You can optionally create the Folder as a subfolder within an existing Folder by providing parent_folder_id in the request body. Subfolder support must be enabled for the Workspace.

post/v2/space/{space_id}/folder

Request

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

Path parameters

space_idnumber required
Example:789

Request body

namestring required
parent_folder_idstring

ID of an existing Folder to create this Folder inside of as a subfolder. The parent Folder must belong to the same Space specified in the path. Subfolder support must be enabled for the Workspace.

Example request

{
  "name": "New Folder Name"
}

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.

statusesItems[] (unresolved $ref)

Statuses defined on this Folder. A newly created Folder inherits its statuses, so this is an empty array unless the Folder overrides them. Entries do not include the status id on this response. To get the resolved statuses for the new Folder, request it with Get Folder.

parent_folderstring

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

Example response

{
  "id": "457",
  "name": "New Folder Name",
  "orderindex": 0,
  "override_statuses": false,
  "hidden": false,
  "space": {
    "id": "789",
    "name": "Space Name",
    "access": true
  },
  "task_count": "0",
  "statuses": []
}

Changes

  • a0a72ec97ddbRevision changes
    • breaking

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

    • info

      added the new optional request property

    • 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