Folders

Folders are the organization structure for files in Workspaces. You can create, update, download, delete folders. You can also list all folders/files in a folder or all files the a user has been invited to directly. Folders may contain both files and/or additional folders. Workspaces themselves are a special folder which is refered to as the root-level folder which you can retrieve.

Create a Folder

Creates a folder in the existing folder specified via [folder_id] within the Workspace specified by [workspace_id]. If you would like to add a file to the root-level of a Workspace, you can do so either by specifying the root_folder_id or by posting to the /folders endpoint without specifying a [folder_id]. If a folder name has characters that would render it invalid, the name will automatically be changed to one that is valid. For example, folder/name would be changed to folder-name.

Parameters

filename Required string The name of the folder.

Return

Returns the newly created folder and a 201 if the call succeeds.

Retrieve a Root-Level Folder (Workspace)

Retrieves the root-level folder for the Workspace specified via [id].

Return

Returns the root-level folder object and a 200 if the call succeeds.

Update a Folder

Updates the folder object specified via [id].

Parameters

filename string The name of the folder.

Return

Returns the updated folder object and a 200 if the call succeeds.

Delete a Folder

Deletes the folder object specified via [id].

Return

Returns an empty message body and a 204 if the call succeeds. Returns a 404 with an error in the message body if a non-existent folder [id] is provided.

List all Folders

Lists all folders within the Workspace specified via [workspace_id] in the folder specified by [id].

Return

Returns a paged array of folder/file objects, along with the containing folder object, and a 200 if the call succeeds.

List all Folders from Direct Invitation

Users can be invited to a Workspace, folder, or file. When invited to a Workspace, a user is automatically granted access to the folders and files within it at their specified role. This endpoint only lists folders that a user has been invited to directly, outside of a Workspace.

Return

Returns a paged array of folder objects and a 200 if the call succeeds.