Folders are the organization structure for files in Workspaces. You can create, update, download, and delete folders. You can also list all items in a folder.
Workspaces contain a special folder which is referred to as the root folder, which you can read. This folder contains all items found in the root of a Workspace.
:folder_id
in the Workspace specified via :workspace_id
. To create a folder at the root-level of the Workspace you can either pass the root_folder_id
or post to the /folders
endpoint without specifying a :folder_id
.:folder_id
is not provided, the API will assume that you want to create the folder at the root-level.{"folder": {"id": 849837,"filename": "New Folder","created_at": "2016-01-20T16:45:48-08:00","updated_at": "2016-01-20T16:45:48-08:00","user_id": 481,"workspace_id": 4137,"ancestor_ids": [849587],"errors": {},"hidden?": false,"size": 0}}
If a folder name contains characters that would render it invalid, the name will be automatically changed to one that is valid. For example folder/name
would be changed to folder-name
.
:id
.{"items": [{"folder": {"id": 849587,"filename": "Testing the API","created_at": "2016-01-15T15:19:06-08:00","updated_at": "2016-01-20T16:53:45-08:00","user_id": null,"workspace_id": 4137,"ancestor_ids": [],"errors": {},"hidden?": false,"size": 6736}}]}
:id
.alphabetical
, modified
, size
, or type
. If Data Room mode and Automatic Indexing are enabled, you can also sort by index
.{"current_page": 1,"total_entries": 0,"total_pages": 0,"offset": 0,"previous_offset": null,"next_offset": null,"per_page": 60,"items": [{"folder": {"id": 849647,"filename": "Nested Folder","created_at": "2016-01-18T17:00:54-08:00","updated_at": "2016-01-18T17:00:54-08:00","user_id": 481,"workspace_id": 4137,"ancestor_ids": [849587,849597],"errors": {},"hidden?": false,"size": 0}},{"file": {"id": 849607,"filename": "onehub-logo.png","created_at": "2016-01-15T16:22:44-08:00","updated_at": "2016-01-20T16:09:25-08:00","user_id": 481,"workspace_id": 4137,"ancestor_ids": [849587,849597],"errors": {},"hidden?": false,"size": 6736,"thumbnail": {"id": 791577,"state": "ready","created_at": "2016-01-15T16:22:44-08:00","updated_at": "2016-01-15T16:22:46-08:00","width": 128,"height": 33,"url": "/thumbnails/791577"}}}],"folder": {"id": 849597,"filename": "Parent Folder","created_at": "2016-01-15T15:19:20-08:00","updated_at": "2016-01-20T16:09:25-08:00","user_id": 481,"workspace_id": 4137,"ancestor_ids": [849587],"errors": {},"hidden?": false,"size": 6736}}
:id
.​
:id
.{"folder": {"id": 849597,"filename": "Renamed Folder","created_at": "2016-01-15T15:19:20-08:00","updated_at": "2016-01-21T11:55:32-08:00","user_id": 481,"workspace_id": 4137,"ancestor_ids": [849587],"errors": {},"hidden?": false,"size": 6736}}
:id
.//
:id
is provided.//