GET api/2.0/files/{folderId}

Description

Returns the detailed list of files and folders located in the folder with the ID specified in the request.

Parameters

Name	Description	Type	Example
folderId sent in url	Folder ID	number	1234
userIdOrGroupId sent in url	User or group ID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
filterType sent in url	Filter type Allowed values: None (0), FilesOnly (1), FoldersOnly (2), DocumentsOnly (3), PresentationsOnly (4), SpreadsheetsOnly (5), ImagesOnly (7), ByUser (8), ByDepartment (9), ArchiveOnly (10), ByExtension (11), MediaOnly (12), EditingRooms (14), CustomRooms (17), OFormTemplateOnly (18), OFormOnly (19) optional	None, FilesOnly, FoldersOnly, DocumentsOnly, PresentationsOnly, SpreadsheetsOnly, ImagesOnly, ByUser, ByDepartment, ArchiveOnly, ByExtension, MediaOnly, EditingRooms, CustomRooms, OFormTemplateOnly, OFormOnly	None
roomId sent in url	Room ID	number	1234
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
excludeSubject sent in url	Specifies whether to exclude a subject or not optional	Bool value	true
applyFilterOption sent in url	Specifies whether to return only files, only folders or all elements from the specified folder optional	ASC.Files.Core.Core.ApplyFilterOption
extension sent in url	Specifies whether to search for a specific file extension	string	some text
searchArea sent in url	Search area Allowed values: Active (0), Archive (1), Any (2), RecentByLinks (3) optional	Active, Archive, Any	Active

Example

GET api/2.0/files/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "userIdOrGroupId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "filterType": "None",
  "roomId": 1234,
  "searchInContent": true,
  "withsubfolders": true,
  "excludeSubject": true,
  "applyFilterOption": null,
  "extension": "some text",
  "searchArea": "Active"
}

Returns

Folder contents

Example Response

{
  "status": 0,
  "response": {
    "Current": {
      "ParentId": 1234,
      "FilesCount": 1234,
      "FoldersCount": 1234,
      "IsShareable": true,
      "IsFavorite": true,
      "New": 1234,
      "Mute": true,
      "Pinned": true,
      "RoomType": "5",
      "Private": true,
      "QuotaLimit": 1234,
      "IsCustomQuota": true,
      "UsedSpace": 1234
    },
    "StartIndex": 1234,
    "Count": 1234,
    "Total": 1234,
    "New": 1234
  }
}

GET api/2.0/files/{folderId}

Get information

Get help