Skip to content

Folders

GET v3/projects/23423233/folders returns all folders and subfolders for the specified project.
[
  {
    "id": 67811577,
    "level": 1,
    "name": "Phase 1 documents",
    "reply_email": "f+107184987-855716680-678115778@mail.proofhub.com",
    "created_at": "2016-12-06T07:06:45+00:00",
    "updated_at": "2016-12-06T07:15:37+00:00",
    "parent_id": "root",
    "type": "folder",
    "project": {
      "id": 23423233
    }
  },
  {
    "id": 67811578,
    "level": 1,
    "name": "Analysis Documents",
    "reply_email": "f+107184987-855716680-678115778@mail.proofhub.com",
    "created_at": "2016-12-06T07:06:45+00:00",
    "updated_at": "2016-12-06T07:15:37+00:00",
    "parent_id": "root",
    "type": "folder",
    "project": {
      "id": 23423233
    }
  }
]
POST v3/projects/23423233/folders creates a new folder in the specified project.

Request Body

{
  "name": "Phase II Document"
}
201 Created is returned along with the folder JSON if the folder is created successfully. 403 Forbidden is returned if access is denied.
PUT v3/projects/23423233/folders/67811578 updates an existing folder.

Request Body

{
  "name": "Phase 2 Documents"
}
200 OK is returned along with the updated folder JSON if the folder is updated successfully. 403 Forbidden is returned if access is denied.
DELETE v3/projects/23423233/folders/67811578 deletes the specified folder and all of its subfolders.

Deleting a folder also deletes all nested subfolders and their contents. This action cannot be undone.

204 No Content is returned if the folder is deleted successfully. 403 Forbidden is returned if access is denied.