Guides
/
Updating code
/
Migrate from using the Sheets folder
Last updated

Migrate from using the Sheets folder

The "Sheets" folder has been deprecated since March 25, 2025. Workspaces replaces it.

Note: See the changelog entry for details.

The following sections explain how to migrate from using the "Sheets" folder endpoints to using Workspaces.

Move all items from the Sheets folder to a workspace

You can create a workspace and move "Sheets" folder items into it via the Smartsheet application UI or the Smartsheet API, as described by the following steps.

Use the following methods to move items and folders from the user's "Sheets" folder to a Workspace.

  1. Use POST /workspaces to create a workspace for the "Sheets" folder items if you don't already have a workspace for them.
  2. Use POST /folders/{folderId}/move to move folders to the workspace.
  3. Use POST /sheets/{sheetId}/move to move sheets to the workspace.
  4. Use POST /sights/{sightId}/move to move dashboards (aka, sights) to the workspace.

Migrate from GET /home

The GET /home method is deprecated and will be removed. This method currently returns the entire hierarchy of items within the user's "Sheets" folder.

To migrate from the GET /home method, follow these steps:

  1. As described in the relevant section above, first move all items and folders from the user's "Sheets" folder to a Workspace.
  2. Call GET /workspaces/{workspaceId}/metadata to get the Workspace's metadata.
  3. Call GET /workspaces/{workspaceId}/children to retrieve paginated metadata on the Workspace's child items.
  4. Call GET /folder/{folderId}/children to retrieve paginated metadata on the child items of the child folders in the Workspace.

To retrieve the full hierarchy, recursively call GET /folder/{folderId}/children on child folders.

Note: The Get ... children methods use token-based pagination.

Migrate from GET /home/folders

The GET /home/folders method is deprecated and will be removed. This method currently lists the child folders of the user's "Sheets" folder.

To migrate from the GET /home/folders method, follow these steps:

  1. As described in the relevant section above, first move all items and folders from the user's "Sheets" folder to a Workspace.
  2. Call GET /workspaces/{workspaceId}/children?childrenResourceTypes=folders to retrieve paginated folder type metadata on the Workspace's folders.

Note: The GET \*children methods use token-based pagination.

Migrate from GET /folders/personal

The GET /folders/personal method is deprecated and will be removed. This method currently lists all items and folders accessible to the user (i.e., items and folders the user owns or has been shared to).

Listing Accessible Items

Use the following methods in place of calling the GET /folders/personal method to list accessible items:

Listing Accessible Folders

Use the following methods in place of calling the GET /folders/personal method to list accessible folders:

Note: The GET */children methods use token-based pagination.

Migrate from POST /sheets

Here are steps for migrating from the POST /sheets method to using Workspaces.

  1. As described in the first section above, move all items and folders from the user's "Sheets" folder to a Workspace.

  2. Use POST /workspaces/{workspaceId}/sheets to create a sheet in the desired workspace.

Migrate from POST /home/folders

Here are steps for migrating from the POST /home/folders method to using Workspaces.

  1. As described in the first section above, move all items and folders from the user's "Sheets" folder to a Workspace.

  2. Use POST /workspaces/{workspaceId}/folders to create a folder in the desired workspace.

Migrate from POST /sheets/import

Here are steps for migrating from the POST /sheets/import method to using Workspaces.

  1. As described in the first section above, move all items and folders from the user's "Sheets" folder to a Workspace.

  2. Use POST /workspaces/{workspaceId}/sheets/import to import a sheet in the desired workspace.

Previous page
Next page