ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Room → Get Room Info

AI-generated

Summary

Retrieves the full details of a single ONLYOFFICE DocSpace room by ID and returns the room object as one output item per input item.

Inputs

  • Authentication (required) — Credential type used for the request: API Key, Basic Auth, OAuth2, or Personal Access Token. The matching DocSpace credential must be configured. Defaults to API Key.
  • Room ID (required) — The room to look up. Choose it from a searchable list of rooms, or enter the numeric ID manually (manual mode is validated with a regex that expects digits).

Output shape

One item per input item. Its JSON is the room object returned by DocSpace's GET api/2.0/files/rooms/{roomId} endpoint (the response field of the API reply).

Read-only call with no side effects. The exact fields depend on the DocSpace API (for example the title and roomType are present). If Continue On Fail is enabled, a failed item returns {error: message} instead of stopping the workflow. A bad ID or missing permissions produce an API error.

Examples

Example 1: Look up a room chosen from a dropdown to read its title and type.

Authentication: API Key; Room ID mode: From List, select the room.

Example 2: Fetch room details for an ID produced by an earlier node, such as Create Room.

Room ID mode: Manual, value set to an expression such as {{ $json.id }}.

Links

Discussion