Actions13
- Manage Smartsheet Actions
- Manage Folder Actions
Overview
This node interacts with the Smartsheet API to manage folders and sheets within those folders. Specifically, for the Manage Folder resource and the Get Sheets List operation, it retrieves all sheets contained in a specified folder. This is useful when you want to programmatically list or process all sheets under a particular folder in your Smartsheet workspace.
Common scenarios include:
- Automating reporting workflows by fetching all sheets in a project folder.
- Synchronizing sheet metadata from a specific folder into another system.
- Building dashboards that aggregate data from multiple sheets within a folder.
Example: Given a folder ID, the node fetches the folder details along with its sheets, returning a structured list of sheet names and their IDs.
Properties
Name | Meaning |
---|---|
Folder ID | The unique identifier of the folder whose sheets you want to list. |
Output
The output JSON contains an object with two main parts:
folder
: An object representing the folder's metadata (such as its ID, name, and other folder properties).namedSheets
: An object where each key is a sheet name and the corresponding value is the sheet's ID.
Example output structure:
{
"folder": {
"id": "123456789",
"name": "Project Folder",
"...": "other folder properties"
},
"namedSheets": {
"Sheet A": 111111,
"Sheet B": 222222,
"Sheet C": 333333
}
}
This allows easy access to both folder information and quick lookup of sheets by name.
The node does not output binary data for this operation.
Dependencies
- Requires an active connection to the Smartsheet API via an API key credential.
- The node uses the Smartsheet REST API v2 endpoint
https://api.smartsheet.com/2.0
. - Proper permissions on the Smartsheet account to read folder and sheet information are necessary.
Troubleshooting
- Invalid Folder ID: If the provided Folder ID does not exist or the API user lacks access, the node will throw an error. Verify the Folder ID and ensure the API key has sufficient permissions.
- Empty Sheets List: If the folder exists but contains no sheets, the
namedSheets
object will be empty. - API Rate Limits: Frequent calls to the Smartsheet API may hit rate limits; consider adding delays or handling retries.
- Network Issues: Connectivity problems can cause request failures; check network status and API availability.