ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Folder → Get Folder Contents

AI-generated

Summary

Lists the contents of a DocSpace folder, room, or the "My documents" section, optionally filtered by a search query. Returns the API's folder listing object for each input item.

Inputs

  • Authentication (required) — Credential type used for the request: API Key, Basic Auth, OAuth2, or Personal Access Token. Determines which credentials are used and where the DocSpace base URL comes from.
  • Is My Documents (required) — If true, lists the "My documents" section (requested as @my) and the Folder ID is ignored. Default false.
  • Folder ID (required) — Numeric ID of the folder or room to list. Shown only when Is My Documents is false.
  • Query — Search text sent as filterValue to filter the contents. Leave empty to return everything.

Output shape

One output item per input item, built from the response object of GET api/2.0/files/{folderId}. It is DocSpace's folder listing, which typically includes the files, subfolders and current folder info.

The source does not set any paging parameters, so the server's default page size applies and large folders may be truncated. With Continue On Fail enabled, a failed item returns { error: message } instead of stopping the workflow. The exact response field names come from the DocSpace API and are not defined in the node source.

Examples

Example 1: List everything in a specific project folder

Is My Documents = false, Folder ID = 12345, Query empty

Example 2: Search the personal documents area for invoices

Is My Documents = true, Query = "invoice"

Links

Discussion