GET api/2.0/files/@trash This function requires authentication

Description

Returns the detailed list of files and folders located in the "Trash" section.

Parameters
Name Description Type Example
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
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
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
Example
GET api/2.0/files/@trash
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "userIdOrGroupId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "filterType": "None",
  "searchInContent": true,
  "withsubfolders": true,
  "applyFilterOption": null
}
Returns

The "Trash" section 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
  }
}