Get Sheets
Description
Retrieves all sheets within a Google Spreadsheet.
The activity returns information about each sheet, including its name, identifier, position, and configuration properties.
Common Capabilities
Process Data Support
This activity supports dynamic configuration using variables from the Process Data drawer.
You can bind values from Agent Data, Workflow Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.
Learn more → Using Process Data
Design-Time Configuration
Display Text
A user-defined name for the activity, displayed on the workflow canvas to help identify its purpose.
Connection Name
The configured Google Sheets connection used to access Google Sheets resources.
Spreadsheet
The spreadsheet from which sheets will be retrieved.
For details about selecting spreadsheets, see Google Sheets Data Selection.
Wait All Incoming
Controls how this activity behaves when multiple incoming execution paths converge.
Determines whether the activity executes when:
- Any incoming path completes, or
- All relevant incoming paths complete before execution
Learn more → Execution Control
On Error
Defines how the workflow behaves if this activity encounters a runtime error.
Supported strategies include:
- Fault
- Continue
- Suspend
- Retry
Output
Sheets
A collection containing information about all sheets in the spreadsheet.
Each sheet includes properties such as:
- Sheet ID
- Sheet Name
- Index
- Sheet Type
- Grid Properties
For details, see:
https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets
Remarks
- The authenticated Google account must have access to the spreadsheet.
- All sheets within the spreadsheet are returned, including hidden sheets.
- The returned collection can be used to inspect sheet names and properties before performing subsequent operations.
- Sheet order is returned according to the order maintained in the spreadsheet.