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.
- Use
POST /workspaces
to create a workspace for the "Sheets" folder items if you don't already have a workspace for them. - Use
POST /folders/{folderId}/move
to move folders to the workspace. - Use
POST /sheets/{sheetId}/move
to move sheets to the workspace. - 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:
- As described in the relevant section above, first move all items and folders from the user's "Sheets" folder to a Workspace.
- Call
GET /workspaces/{workspaceId}/metadata
to get the Workspace's metadata. - Call
GET /workspaces/{workspaceId}/children
to retrieve paginated metadata on the Workspace's child items. - 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:
- As described in the relevant section above, first move all items and folders from the user's "Sheets" folder to a Workspace.
- 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:
GET /reports
lists reports accessible to the user.GET /sheets
lists sheets accessible to the user.GET /sights
lists dashboards accessible to the user.GET /templates
lists user-created templates accessible to the user.GET /templates/public
lists public templates accessible to the user.
Listing Accessible Folders
Use the following methods in place of calling the GET /folders/personal
method to list accessible folders:
GET /workspaces
lists Workspaces accessible to the user.GET /workspaces/{workspaceId}/children?childrenResourceTypes=folders
retrieves paginated folder type metadata for the child folders of the matching Workspace.GET /folders/{folderId}/children?childrenResourceTypes=folders
retrieves paginated folder type metadata for the child folders of the matching folder.
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.
As described in the first section above, move all items and folders from the user's "Sheets" folder to a Workspace.
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.
As described in the first section above, move all items and folders from the user's "Sheets" folder to a Workspace.
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.
As described in the first section above, move all items and folders from the user's "Sheets" folder to a Workspace.
Use
POST /workspaces/{workspaceId}/sheets/import
to import a sheet in the desired workspace.