ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

User → Search User

AI-generated

Summary

Searches users across the whole ONLYOFFICE DocSpace portal by an optional text query and returns the matching user records.

Inputs

  • authentication (required) — Authentication method: API Key, Basic Auth, OAuth2, or Personal Access Token. Selects which credential type the node uses. Defaults to API Key.
  • query — Search text, sent to DocSpace as the filterValue parameter. If empty, no filter is applied and all users are requested.

Output shape

For each input item, the DocSpace response array of user objects is split into one output item per user. The fields are those the DocSpace API returns, such as id, displayName and email.

The node sends a GET request to api/2.0/people/filter. It sets no paging parameters, so the result size is whatever the API returns by default. This operation is separate from the Room > Search User operation, which searches users inside one room. If Continue On Fail is enabled, a failed item returns an object with an error message.

Examples

Example 1: Look up portal users whose name or email matches a term from an earlier node.

Authentication: API Key; Query: {{$json.name}}

Example 2: List every user on the portal.

Authentication: Personal Access Token; Query left empty

Links

Discussion