GET api/2.0/files/rooms This function requires authentication

Description

Returns the contents of the "Rooms" section by the parameters specified in the request.

Parameters
Name Description Type Example
type
sent in url
Filter by room type
optional
FillingFormsRoom = 1, EditingRoom = 2, ReviewRoom = 3, ReadOnlyRoom = 4, CustomRoom = 5, PublicRoom = 6 5
subjectId
sent in url
Filter by user ID string some text
searchInContent
sent in url
Specifies whether to search within the section contents or not
optional
Bool value true
withSubfolders
sent in url
Specifies whether to return sections with or without subfolders
optional
Bool value true
searchArea
sent in url
Room search area (Active, Archive, Any)
optional
Active, Archive, Any Active
withoutTags
sent in url
Specifies whether to search by tags or not
optional
Bool value true
tags
sent in url
Tags in the serialized format string some text
excludeSubject
sent in url
Specifies whether to exclude a subject or not
optional
Bool value true
provider
sent in url
Filter by provider name (None, Box, DropBox, GoogleDrive, kDrive, OneDrive, SharePoint, WebDav, Yandex)
optional
None, Box, DropBox, GoogleDrive, kDrive, OneDrive, SharePoint, WebDav, Yandex Box
subjectFilter
sent in url
Filter by subject (Owner - 1, Member - 1)
optional
Owner, Member Owner
Example
GET api/2.0/files/rooms
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "type": "5",
  "subjectId": "some text",
  "searchInContent": true,
  "withSubfolders": true,
  "searchArea": "Active",
  "withoutTags": true,
  "tags": "some text",
  "excludeSubject": true,
  "provider": "Box",
  "subjectFilter": "Owner"
}
Returns

Rooms contents

Example Response
{
  "status": 0,
  "response": {
    "Current": {
      "ParentId": 1234,
      "FilesCount": 1234,
      "FoldersCount": 1234,
      "New": 1234,
      "Mute": true,
      "Pinned": true,
      "Private": true
    },
    "StartIndex": 1234,
    "Count": 1234,
    "Total": 1234,
    "New": 1234
  }
}