Get rooms

GET /api/2.0/files/rooms

Request

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

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json, text/json, text/plain.

Query

typearray of one of

Filter by room type

.enum of string

[FillingFormsRoom - Form filling room, EditingRoom - Collaboration room, CustomRoom - Custom room, PublicRoom - Public room, VirtualDataRoom - Virtual data room]

Can be one of: FillingFormsRoom, EditingRoom, CustomRoom, PublicRoom, VirtualDataRoom.

.enum of integer

[1 - Form filling room, 2 - Collaboration room, 5 - Custom room, 6 - Public room, 8 - Virtual data room]

Can be one of: 1, 2, 5, 6, 8.

subjectIdstring

Filter by user ID

searchInContentboolean

Specifies whether to search within the section contents or not

withSubfoldersboolean

Specifies whether to return sections with or without subfolders

searchAreaone of

Room search area (Active, Archive, Any)

.enum of string

[Active - Active, Archive - Archive, Any - Any, RecentByLinks - Recent by links]

Can be one of: Active, Archive, Any, RecentByLinks.

.enum of integer

[0 - Active, 1 - Archive, 2 - Any, 3 - Recent by links]

Can be one of: 0, 1, 2, 3.

withoutTagsboolean

Specifies whether to search by tags or not

tagsstring

Tags in the serialized format

excludeSubjectboolean

Specifies whether to exclude a subject or not

providerone of

Filter by provider name (None, Box, DropBox, GoogleDrive, kDrive, OneDrive, WebDav)

.enum of string

[None - None, Box - Box, DropBox - DropBox, GoogleDrive - GoogleDrive, kDrive - kDrive, OneDrive - OneDrive, SharePoint - SharePoint, WebDav - WebDav, Yandex - Yandex, Storage - Storage]

Can be one of: None, Box, DropBox, GoogleDrive, kDrive, OneDrive, SharePoint, WebDav, Yandex, Storage.

.enum of integer

[0 - None, 1 - Box, 2 - DropBox, 3 - GoogleDrive, 4 - kDrive, 5 - OneDrive, 6 - SharePoint, 7 - WebDav, 8 - Yandex, 9 - Storage]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9.

subjectFilterone of

Filter by subject (Owner - 1, Member - 1)

.enum of string

[Owner - Owner, Member - Member]

Can be one of: Owner, Member.

.enum of integer

[0 - Owner, 1 - Member]

Can be one of: 0, 1.

quotaFilterone of

Filter by quota (Default - 1, Custom - 2)

.enum of string

[All - All, Default - Default, Custom - Custom]

Can be one of: All, Default, Custom.

.enum of integer

[0 - All, 1 - Default, 2 - Custom]

Can be one of: 0, 1, 2.

storageFilterone of

Filter by storage (Internal - 1, ThirdParty - 2)

.enum of string

[None - None, Internal - Internal, ThirdParty - ThirdParty]

Can be one of: None, Internal, ThirdParty.

.enum of integer

[0 - None, 1 - Internal, 2 - ThirdParty]

Can be one of: 0, 1, 2.

Examples

GET /api/2.0/files/rooms?subjectId=some%20text&searchInContent=true&withSubfolders=true&withoutTags=true&tags=some%20text&excludeSubject=true HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/files/rooms?subjectId=some%20text&searchInContent=true&withSubfolders=true&withoutTags=true&tags=some%20text&excludeSubject=true' \
  --header 'Accept: application/json'

Responses

200

Returns the contents of the "Rooms" section

filesarray of object

List of files

titlestring

Title

accessone of

.enum of string

[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomManager - Room manager, Editing - Editing, ContentCreator - Content creator]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomManager, Editing, ContentCreator.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room manager, 10 - Editing, 11 - Content creator]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedboolean

Specifies if the file is shared or not

createdobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

createdByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

updatedobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

autoDeleteobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

rootFolderTypeone of

.enum of string

[DEFAULT - Default, COMMON - Coomon, BUNCH - Bunch, TRASH - Trash, USER - User, SHARE - Share, Projects - Projects, Favorites - Favourites, Recent - Recent, Templates - Templates, Privacy - Privacy, VirtualRooms - Virtual rooms, FillingFormsRoom - Filling forms room, EditingRoom - Editing room, CustomRoom - Custom room, Archive - Archive, ThirdpartyBackup - Thirdparty backup, PublicRoom - Public room, ReadyFormFolder - Ready form folder, InProcessFormFolder - In process form folder, FormFillingFolderDone - Form filling folder done, FormFillingFolderInProgress - Form filling folder in progress, VirtualDataRoom - Virtual Data Room]

Can be one of: DEFAULT, COMMON, BUNCH, TRASH, USER, SHARE, Projects, Favorites, Recent, Templates, Privacy, VirtualRooms, FillingFormsRoom, EditingRoom, CustomRoom, Archive, ThirdpartyBackup, PublicRoom, ReadyFormFolder, InProcessFormFolder, FormFillingFolderDone, FormFillingFolderInProgress, VirtualDataRoom.

.enum of integer

[0 - Default, 1 - Coomon, 2 - Bunch, 3 - Trash, 5 - User, 6 - Share, 8 - Projects, 10 - Favourites, 11 - Recent, 12 - Templates, 13 - Privacy, 14 - Virtual rooms, 15 - Filling forms room, 16 - Editing room, 19 - Custom room, 20 - Archive, 21 - Thirdparty backup, 22 - Public room, 25 - Ready form folder, 26 - In process form folder, 27 - Form filling folder done, 28 - Form filling folder in progress, 29 - Virtual Data Room]

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

parentRoomTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

updatedByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

providerItemboolean

Provider is specified or not

providerKeystring

Provider key

providerIdintegerformat: int32

Provider ID

orderstring

Order

fileEntryTypeenum of integerformat: int32

Can be one of: 1, 2.

foldersarray of object

List of folders

titlestring

Title

accessone of

.enum of string

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomManager, Editing, ContentCreator.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room manager, 10 - Editing, 11 - Content creator]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedboolean

Specifies if the file is shared or not

createdobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

createdByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

updatedobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

autoDeleteobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

rootFolderTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

parentRoomTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

updatedByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

providerItemboolean

Provider is specified or not

providerKeystring

Provider key

providerIdintegerformat: int32

Provider ID

orderstring

Order

fileEntryTypeenum of integerformat: int32

Can be one of: 1, 2.

currentobject

titlestring

Title

accessone of

.enum of string

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomManager, Editing, ContentCreator.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room manager, 10 - Editing, 11 - Content creator]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedboolean

Specifies if the file is shared or not

createdobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

createdByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

updatedobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

autoDeleteobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

rootFolderTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

parentRoomTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

updatedByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

providerItemboolean

Provider is specified or not

providerKeystring

Provider key

providerIdintegerformat: int32

Provider ID

orderstring

Order

idintegerformat: int32

rootFolderIdintegerformat: int32

Root folder id

originIdintegerformat: int32

Origin id

originRoomIdintegerformat: int32

Origin room id

originTitlestring

Origin title

originRoomTitlestring

Origin room title

canShareboolean

Can share

securityobject

Security

Readboolean
Commentboolean
FillFormsboolean
Reviewboolean
Createboolean
Editboolean
Deleteboolean
CustomFilterboolean
EditRoomboolean
Renameboolean
ReadHistoryboolean
Lockboolean
EditHistoryboolean
CopyToboolean
Copyboolean
MoveToboolean
Moveboolean
Pinboolean
Muteboolean
EditAccessboolean
Duplicateboolean
SubmitToFormGalleryboolean
Downloadboolean
Convertboolean
CopySharedLinkboolean
ReadLinksboolean
Reconnectboolean
CreateRoomFromboolean
CopyLinkboolean
Embedboolean
ChangeOwnerboolean
IndexExportboolean

requestTokenstring

parentIdintegerformat: int32

Parent folder ID

filesCountintegerformat: int32

Number of files

foldersCountintegerformat: int32

Number of folders

isShareableboolean

Specifies if a folder is shareable or not

isFavoriteboolean

Specifies if a folder is favorite or not

newintegerformat: int32

Number for a new folder

muteboolean

Specifies if a folder is muted or not

tagsarray of string

List of tags

logoobject

originalstring

Original

largestring

Large

mediumstring

Medium

smallstring

Small

colorstring

Color

coverobject

idstring
datastring

pinnedboolean

Specifies if a folder is pinned or not

roomTypeone of

.enum of string

[FillingFormsRoom - Form filling room, EditingRoom - Collaboration room, CustomRoom - Custom room, PublicRoom - Public room, VirtualDataRoom - Virtual data room]

Can be one of: FillingFormsRoom, EditingRoom, CustomRoom, PublicRoom, VirtualDataRoom.

.enum of integer

[1 - Form filling room, 2 - Collaboration room, 5 - Custom room, 6 - Public room, 8 - Virtual data room]

Can be one of: 1, 2, 5, 6, 8.

privateboolean

Specifies if a folder is private or not

indexingboolean

Indexing

denyDownloadboolean

Deny download

lifetimeobject

deletePermanentlyboolean: Specifies action
periodenum of integerformat: int32: Can be one of: 0, 1, 2.
valueintegerformat: int32: Specifies time period value
enabledboolean: Enabled

watermarkobject

additionsone of

.enum of string

[UserName - User name, UserEmail - User email, UserIpAdress - User ip adress, CurrentDate - Current date, RoomName - Room name]

Can be one of: UserName, UserEmail, UserIpAdress, CurrentDate, RoomName.

.enum of integer

[1 - User name, 2 - User email, 4 - User ip adress, 8 - Current date, 16 - Room name]

Can be one of: 1, 2, 4, 8, 16.

textstring

Watermark Text

rotateintegerformat: int32

Watermark text and image rotate

imageScaleintegerformat: int32

Watermark image scale

imageUrlstring

Watermark image url

imageHeightnumberformat: double

Watermark image height

imageWidthnumberformat: double

Watermark image width

typeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

inRoomboolean

InRoom

quotaLimitintegerformat: int64

Quota

isCustomQuotaboolean

Specifies if the room has a custom quota or not

usedSpaceintegerformat: int64

Counter

externalboolean

Specifies if the link external

passwordProtectedboolean

Specifies if the password protected

expiredboolean

Expired

fileEntryTypeenum of integerformat: int32

Can be one of: 1, 2.

pathPartsunknown

Folder path

startIndexintegerformat: int32

Folder start index

countintegerformat: int32

Number of folder elements

totalintegerformat: int32

Total number of elements in the folder

newintegerformat: int32

New element index

401

Unauthorized

403

You don't have enough permission to view the room content

Get Help

If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).

Get rooms

Request

Authorization

Headers

Query

Examples

Responses

200

401

403

Results

Get Help