SharePoint integration

Get Rows

Perform Get Rows through SharePoint.

View as Markdown

sharepoint_excel_get_rows

writesharepoint

Inputs

workbook_url
expressionrequired
Workbook Url
Required literal value or workflow expression.
worksheet_name
selectrequireddynamic options
Worksheet Name
Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
header_row
number
Header Row
Optional numeric value.
Default: 1
max_rows
number
Max Rows
Optional numeric value.
Default: 1000
filter_column
expression
Filter Column
Optional literal value or workflow expression.
filter_value
expression
Filter Value
Optional literal value or workflow expression.
skip_empty_rows
boolean
Skip Empty Rows
Optional true-or-false value.
Default: true

Outputs

successSuccess
workbookWorkbook
worksheetWorksheet
headersHeaders
rowsRows
row_countRow Count
first_column_indexFirst Column Index
truncatedTruncated
errorError
error_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"
    },
    "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": {},
    "workbook": {},
    "row_count": {},
    "truncated": {},
    "worksheet": {},
    "error_message": {},
    "first_column_index": {}
  },
  "additionalProperties": true
}

View all SharePoint actions