Get Rows
Perform Get Rows through SharePoint.
sharepoint_excel_get_rowsUse in a workflow
Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.
{
"_group": "SharePoint",
"params": {
"max_rows": 1000,
"read_mode": "legacy",
"header_row": 1,
"skip_empty_rows": true
},
"handler": "sharepoint_excel_get_rows"
}Inputs
- Workbook Url
workbook_urlexpressionrequiredRequired literal value or workflow expression.
- Worksheet Name
worksheet_nameselectrequireddynamic optionsRequired selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
- Header Row
header_rownumberOptional numeric value.
Default:
1 - Read Mode
read_modeselectOptional selected identifier or value.
Default:
"legacy"Options: All matching rows ("all"), Up to N matching rows ("limited"), First matching row (Excel lookup) ("lookup"), First rows (existing behavior) ("legacy"), Headers and row bounds ("bounds")
- Max Rows
max_rowsnumberOptional numeric value.
Default:
1000 - Filter Column
filter_columnexpressionOptional literal value or workflow expression.
- Filter Value
filter_valueexpressionOptional literal value or workflow expression.
- Skip Empty Rows
skip_empty_rowsbooleanOptional true-or-false value.
Default:
true
Outputs
successSuccessworkbookWorkbookworksheetWorksheetheadersHeadersrowsRowspreview_rowsPreview Rowsrow_countRow Countlast_row_numberLast Row NumberwarningsWarningsfirst_column_indexFirst Column IndextruncatedTruncatederrorErrorerror_messageError Message
Output schema completeness: best_effort_declared
Safety
- External effect
- write
- Confirmation recommended
- No
- Retry safe
- No
- Dry run supported
- No
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"required": [
"workbook_url",
"worksheet_name"
],
"properties": {
"max_rows": {
"type": "number",
"default": 1000,
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"read_mode": {
"enum": [
"all",
"limited",
"lookup",
"legacy",
"bounds"
],
"type": "string",
"default": "legacy",
"description": "Optional selected identifier or value.",
"x-workflow-field-type": "select"
},
"header_row": {
"type": "number",
"default": 1,
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"filter_value": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"workbook_url": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"filter_column": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"worksheet_name": {
"type": "string",
"description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
"x-dynamic-options": true,
"x-workflow-field-type": "select"
},
"skip_empty_rows": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"rows": {},
"error": {},
"headers": {},
"success": {},
"warnings": {},
"workbook": {},
"row_count": {},
"truncated": {},
"worksheet": {},
"preview_rows": {},
"error_message": {},
"last_row_number": {},
"first_column_index": {}
},
"additionalProperties": true
}