Workspaces
Workspaces are the top-level organizational structure for folders and files. Workspaces are also a root_folder
whose contents can be examined via the Folders endpoint.
Create a Workspace
POST
https://ws-api.onehub.com/workspaces
Creates a new Workspace owned by the user.
Request Body
Name | Type | Description |
---|---|---|
workspace[name] | string | The name of the Workspace. |
workspace[background_color] | string | A CSS hex color value that determines the background color for the Workspace. |
workspace[data_room] | boolean | Activates Data Room mode for the Workspace. Defaults to |
workspace[default_view] | string | Determines whether first time visitors should see folders and files displayed as horizontal |
Read a Workspace
GET
https://ws-api.onehub.com/workspaces/:id
Retrieve the Workspace specified via :id
.
Path Parameters
Name | Type | Description |
---|---|---|
:id | integer | The unique identifier of the Workspace you would like to retrieve. |
Update a Workspace
PUT
https://ws-api.onehub.com/workspaces/:id
Updates the Workspace specified via :id
.
Path Parameters
Name | Type | Description |
---|---|---|
:id | integer | The unique identifier of the Workspace you would like to update. |
Request Body
Name | Type | Description |
---|---|---|
workspace[name] | string | The name of the Workspace. |
workspace[background_color] | string | A CSS hex color value that determines the background color for the Workspace. |
workspace[data_room] | boolean | Activates Data Room mode for the Workspace. Defaults to |
workspace[default_view] | string | Determines whether first time visitors should see folders and files displayed as horizontal |
Delete a Workspace
DELETE
https://ws-api.onehub.com/workspaces/:id
Delete the Workspace specified via :id
.
Path Parameters
Name | Type | Description |
---|---|---|
:id | integer | The unique identifier of the Workspace you would like to delete. |
List all Workspaces
GET
https://ws-api.onehub.com/workspaces
List all Workspaces that the user has been invited to.
Last updated