ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Folder → Get Folder Shared Link

AI-generated

Summary

Retrieves the shared link information for a DocSpace folder by its numeric ID, using a GET request to the folder's link endpoint.

Inputs

  • Authentication (required) — Auth method and matching credential: API Key (default), Basic Auth, OAuth2, or Personal Access Token.
  • Folder ID (required) — Numeric ID of the folder to get the shared link for.

Output shape

One output item per input item, containing the response object returned by DocSpace's folder link endpoint (api/2.0/files/folder/{folderId}/link).

The source doesn't transform the response, so the exact fields (such as the link URL and access settings) are whatever DocSpace returns. It is a read-only call and doesn't create or change the link. If an item fails and Continue On Fail is enabled, that item returns {error: message}. Otherwise the node throws.

Examples

Example 1: Fetch the share link of a project folder so it can be sent in a notification.

Authentication: API Key; Folder ID: 12345

Example 2: Look up shared links for folders created earlier in the workflow.

Folder ID set by expression to the ID returned from a Create Folder step, e.g. {{ $json.id }}

Links

Discussion