Synology Office icon

Synology Office

Synology Office / Spreadsheet helper node

List Spreadsheets

AI-generated

Summary

List spreadsheets from a specified folder in Synology Office with pagination support.

Inputs

  • Folder ID — ID of the folder to list spreadsheets from; defaults to '0' for root folder.
  • Offset — Number of spreadsheets to skip before starting to collect the results; defaults to 0.
  • Limit — Maximum number of spreadsheets to return; defaults to 50.
  • Extra Params (JSON) — Optional additional parameters in JSON format to merge into the API call, useful for accommodating different DSM parameter names.

Output shape

a JSON object containing the list of spreadsheets and metadata as returned by the Synology DSM API.

The operation returns data from either the 'SYNO.Office.File' or 'SYNO.Office.OFile' API with 'list' or 'query' methods. The response includes spreadsheet files filtered by type and paged by offset and limit. The extra parameters, if provided, override or extend the standard API call parameters.

Examples

Example 1: List first 50 spreadsheets in root folder

Folder ID = '0', Offset = 0, Limit = 50

Example 2: List spreadsheets starting from the 100th item

Folder ID = '0', Offset = 100, Limit = 50

Links

Discussion