Unitalk Microsoft Excel 365 icon

Unitalk Microsoft Excel 365

Consume Microsoft Excel API

Actions17

Sheet → Get Rows

AI-generated

Summary

Retrieve rows from a specified Excel sheet within a workbook, optionally using a defined range and filtering columns. Supports returning either parsed row data with column headers as keys or raw data arrays.

Inputs

  • workbook (required) — Select the Excel workbook from which to retrieve rows. Can be chosen from a list or specified by ID.
  • worksheet (required) — Select the sheet within the workbook to retrieve rows from. Can be chosen from a list or specified by ID.
  • useRange — Enable to specify a custom A1-style range within the sheet to read data from. If disabled, reads the entire used range of the sheet.
  • range — The specific A1-style range (e.g., A1:B2) to read data from when 'useRange' is enabled. Must be precise, generic ranges like 'A:B' are unsupported.
  • keyRow — Zero-based index indicating which row of the selected range contains the column headers. Defaults to 0, relative to the selected range.
  • dataStartRow — Zero-based index indicating the first row of actual data (not headers) within the selected range. Defaults to 1, relative to the selected range.
  • options.rawData — Set to true to return raw row data arrays without mapping to column headers.
  • options.dataProperty — When returning raw data, specifies the JSON property name to hold the raw data array. Defaults to 'data'.
  • options.fields — When returning raw data, specify a comma-separated list of fields to include in the response.
  • filters.fields — When rawData is true, fields to include in the response. Comma-separated list.
  • filters.column — When rawData is false, an optional list of column names or IDs to include in the output. If set, only these columns are returned.

Output shape

a list of items representing rows of the sheet, each as an object with keys mapped from column headers unless rawData is true, in which case a single item with a property containing raw data arrays is returned.

If rawData is false, each row is returned as a separate item object with keys from the header row; if true, all rows are returned inside a single item under the configured property name. Supports pagination with limit and returnAll options. Errors per item are included if 'continueOnFail' is enabled.

Links

Discussion