ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Room → Search Room

AI-generated

Summary

Searches ONLYOFFICE DocSpace rooms by an optional text query and returns the matching rooms listing. With an empty query it returns all rooms visible to the authenticated user.

Inputs

  • authentication (required) — Authentication method: API Key, Basic Auth, OAuth2, or Personal Access Token. Selects which DocSpace credential type is used for the request.
  • query — Search text for rooms. Sent as the filterValue query parameter; if empty, no filter is applied and all rooms are returned.

Output shape

For each input item, the DocSpace response object from GET api/2.0/files/rooms, emitted as n8n JSON item(s). The room entries are in its folders array (each with id, title, etc.).

No pagination parameters are set, so results are whatever the DocSpace API returns by default. If 'Continue On Fail' is enabled, a failed item outputs an object with an error message instead.

Examples

Example 1: List every room in the portal

Resource: Room, Operation: Search Room, Query left empty.

Example 2: Find a room by name before inviting a user

Query: "Marketing"; use the returned room id in a following Invite User step.

Links

Discussion