ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Folder → Get Folder Info

AI-generated

Summary

Retrieves metadata for a single ONLYOFFICE DocSpace folder, either by numeric folder ID or for the authenticated user's "My documents" section.

Inputs

  • Authentication (required) — Credential method used for the request: API Key, Basic Auth, OAuth2 or Personal Access Token. Selects which DocSpace credential is used and supplies the base URL.
  • Is My Documents (required) — If true, the node looks up the authenticated user's "My documents" folder and returns its info. If false, a Folder ID must be supplied.
  • Folder ID (required) — Numeric ID of the folder to fetch. Shown only when Is My Documents is false.

Output shape

One output item per input item, with the folder's info object from DocSpace as JSON (the response field of the API reply).

With Is My Documents enabled, the node first makes an extra call to api/2.0/files/@my to resolve the folder ID, then fetches api/2.0/files/folder/{id}. If continue-on-fail is enabled, a failed item returns {error: message} instead of stopping the workflow.

Examples

Example 1: Fetch details of a specific folder by ID

Is My Documents = false, Folder ID = 12345

Example 2: Get the current user's My documents folder metadata (e.g. to find its ID)

Is My Documents = true

Links

Discussion