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 false. Availability of this feature is plan dependent.
workspace[default_view]	string	Determines whether first time visitors should see folders and files displayed as horizontal rows or as a grid of large thumbnails. Defaults to rows.

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

{
  "workspace": {
    "id": 4137,
    "name": "Testing the API",
    "background_color": "#58b28d",
    "updated_at": "2016-01-25T16:39:34-08:00",
    "data_room": false,
    "default_view": "rows",
    "default_sort": "alphabetical",
    "root_folder_id": 849927,
    "owner_id": 481,
    "audit_trail": true,
    "is_owner": true,
    "require_agreement": false,
    "agreement_accepted": false,
    "effective_role": "Administrator",
    "errors": {}
  }
}

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.

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

{
  "workspace": {
    "id": 4137,
    "name": "Testing the API",
    "background_color": "#58b28d",
    "updated_at": "2016-01-25T16:39:34-08:00",
    "data_room": false,
    "default_view": "rows",
    "default_sort": "alphabetical",
    "root_folder_id": 849927,
    "owner_id": 481,
    "audit_trail": true,
    "is_owner": true,
    "require_agreement": false,
    "agreement_accepted": false,
    "effective_role": "Administrator",
    "errors": {}
  }
}

404 Returns a 404 with an error in the message body if an invalid Workspace :id is provided.

//

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 false. Availability of this feature is plan dependent.
workspace[default_view]	string	Determines whether first time visitors should see folders and files displayed as horizontal rows or as a grid of large thumbnails. Defaults to rows.

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

{
  "workspace": {
    "id": 4137,
    "name": "Testing the API",
    "background_color": "#58b28d",
    "updated_at": "2016-01-25T16:39:34-08:00",
    "data_room": false,
    "default_view": "thumbnails",
    "default_sort": "alphabetical",
    "root_folder_id": 849927,
    "owner_id": 481,
    "audit_trail": true,
    "is_owner": true,
    "require_agreement": false,
    "agreement_accepted": false,
    "effective_role": "Administrator",
    "errors": {}
  }
}

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.

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

//

List all Workspaces

GET https://ws-api.onehub.com/workspaces

List all Workspaces that the user has been invited to.

200 Returns a paginated array of Workspace objects and a 200 if the call succeeds.

{
  "current_page": 1,
  "total_entries": 1,
  "total_pages": 1,
  "offset": 0,
  "previous_offset": null,
  "next_offset": null,
  "per_page": 30,
  "items": [
    {
      "workspace": {
        "id": 4137,
        "name": "Testing the API",
        "background_color": "#58b28d",
        "updated_at": "2016-01-25T16:54:00-08:00",
        "data_room": false,
        "default_view": "thumbnails",
        "default_sort": "alphabetical",
        "root_folder_id": 849587,
        "owner_id": 481,
        "audit_trail": true,
        "is_owner": true,
        "require_agreement": false,
        "agreement_accepted": false,
        "effective_role": "Administrator",
        "errors": {}
      }
    }
  ]
}