Synology Sheets icon

Synology Sheets

Create, read, write, and manage Synology spreadsheets via Docker API

Actions14

Read Cells

AI-generated

Summary

Read cell values from a specified range in a Synology spreadsheet sheet.

Inputs

  • Spreadsheet ID (required) — The unique identifier of the spreadsheet to read from (e.g., 17Hx...)
  • Sheet ID (required) — The identifier of the sheet within the spreadsheet (e.g., sh_1, sh_2). Use the "Get Spreadsheet" operation to find available sheet IDs.
  • Cell Range (required) — The A1 notation range of cells to read (e.g., "Sheet1!A1:B2").

Output shape

a single JSON object containing the read cell values from the specified range

Returns the cell data as JSON from the range specified by the cellRange parameter. The data corresponds to the spreadsheet identified by spreadsheetId and the specified cell range. Errors are returned based on the request and authentication status.

Examples

Example 1: Read the values from cells A1 to B2 in sheet with ID 'sh_1' of a spreadsheet.

Set Spreadsheet ID to the target spreadsheet's ID, Sheet ID to 'sh_1', and Cell Range to 'Sheet1!A1:B2'.

Links

Discussion