Folders

View the Folders in a Space. Subfolders are returned in the same flat list as top-level Folders, each with a parent_folder field holding the ID of the Folder it is nested inside of. This endpoint does not nest them; to get a Folder's subfolder tree, use Get Folder with include_subfolders=true.

get/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

Query parameters

archivedboolean

Response

Example response

{
  "folders": [
    {
      "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": [],
      "lists": []
    },
    {
      "id": "458",
      "name": "Second Folder Name",
      "orderindex": 1,
      "override_statuses": false,
      "hidden": false,
      "space": {
        "id": "789",
        "name": "Space Name",
        "access": true
      },
      "task_count": "0",
      "statuses": [],
      "lists": [],
      "parent_folder": "457"
    }
  ]
}

Changes

    • breaking

      the response body contentMediaType changed from application/json to for the status

    • breaking

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

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status