ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Room → Search User

AI-generated

Summary

Lists the users who have access to a chosen ONLYOFFICE DocSpace room, optionally filtered by a search query. Calls GET api/2.0/files/rooms/{roomId}/share and returns the members as separate items.

Inputs

  • authentication (required) — Credential type to use: API Key, Basic Auth, OAuth2, or Personal Access Token. Defaults to API Key.
  • roomId (required) — The room to search in. Pick from a searchable list of rooms or enter the numeric ID manually (manual mode validates that it is a number).
  • query — Text sent as the filterValue parameter to filter the room's users. If left empty, no filter is sent and all users in the room are returned.

Output shape

A list of output items, one per entry in the room's share list (the API's response array). Each entry is a user's or group's sharing record for the room. The source doesn't show the exact fields; the room-user dropdown code reads sharedTo.displayName and sharedTo.id from each entry.

Runs once per input item, and each result item is paired with its input item. If the room has no matching users, the response array is empty and no items are returned for that input. With Continue On Fail enabled, a failure returns an item containing an error message instead of stopping the workflow. No pagination parameters are set, so the API's default page size applies.

Examples

Example 1: List all members of a specific room

Authentication: API Key; Room ID: choose from list; Query: empty

Example 2: Find a user in a room by name or email fragment

Room ID (manual): 12345; Query: "john"

Example 3: Check whether a user already has access before inviting them

Room ID: {{ $json.roomId }} (manual mode); Query: {{ $json.email }}, followed by an IF node on the item count

Links

Discussion