Workspaces

Workspaces are the top-level organizational structure for folders and files. Workspaces are also a root_folder whose contents can be examind via the Folders method.

Create a Workspace

Creates a new Workspace owned by the user.

Parameters

name string The name of the Workspace.
background_color string A CSS hex color value representing the background color for a Workspace.
data_room boolean Is the Workspace is a data room? Default is false.
default_view string If this is set to rows, first time visitors will see files displayed as a horizontal list with small thumbnails. If this is set to thumbnails, first time visitors will see files displayed as a square grid with large thumbnails. Default is rows.

Return

Returns the newly created Workspace object and a 200 if the call succeeds.

Retrieve a Workspace

Retrieve the Workspace specified via [id].

Return

Returns the Workspace object and a 200 if the call succeeds. Returns a 404 with an error in the message body if an invalid Workspace [id] is provided.

Update a Workspace

Updates the Workspace specified via [id].

name string The name of the Workspace.
background_color string A CSS hex color value representing the background color for a Workspace.
data_room boolean Is the Workspace is a data room? Default is false.
default_view string If this is set to rows, first time visitors will see files displayed as a horizontal list with small thumbnails. If this is set to thumbnails, first time visitors will see files displayed as a square grid with large thumbnails. Default is rows.

Return

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

Delete a Workspace

Delete the individual Workspace object specified via [id].

Return

Returns an empty message body and a 204 if the call succeeds.

List all Workspaces

Lists all Workspaces that the user has been invited to.

Return

Returns a paged array of Workspace objectss and a 200 if the call succeeds.