Skip to main content

Get Sheets

Retrieves the list of sheets in a Google Spreadsheet.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Spreadsheet Id - The ID of the Google Spreadsheet from which to retrieve the list of sheets.

Options​

No additional options available for this node.

Output​

  • Sheets - An array of objects containing sheet information, including sheet names and IDs.

How It Works​

The Get Sheets node retrieves metadata about all sheets in a Google Spreadsheet. When executed, the node:

  1. Validates the Spreadsheet Id input
  2. Connects to the Google Spreadsheet using the provided ID
  3. Retrieves metadata for all sheets in the spreadsheet
  4. Processes the metadata to extract sheet names and IDs
  5. Formats the data as an array of objects with sheetName and sheetId properties
  6. Sets the processed data to the output variable
  7. Returns any errors encountered during the process

Requirements​

  • A valid Google Spreadsheet ID
  • Proper Google Sheets API authentication and permissions

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Spreadsheet Id
  • Google Sheets API authentication or permission errors
  • Network or connectivity issues with Google Sheets API

Usage Notes​

  • The Spreadsheet Id can be obtained from the URL of your Google Spreadsheet
  • The output Sheets variable contains an array of objects, each with sheetName and sheetId properties
  • This node is useful for dynamically working with spreadsheets that have multiple sheets
  • The sheetId can be used in other nodes that require a specific sheet ID
  • Ensure your Google account has proper permissions to read metadata from the target spreadsheet