Get Started
Usage API
More information

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
optional
None, FilesOnly, FoldersOnly, DocumentsOnly, PresentationsOnly, SpreadsheetsOnly, ImagesOnly, ByUser, ByDepartment, ArchiveOnly, ByExtension, MediaOnly
Example
GET api/2.0/files/@trash?userIdOrGroupId=9924256A-739C-462b-AF15-E652A3B1B6EB&filterType=none
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Trash section contents

Example Response

application/json

{
  "status": 0,
  "response": {
    "files": [
      {
        "folderId": 12334,
        "version": 3,
        "versionGroup": 1,
        "contentLength": "12.06 KB",
        "pureContentLength": 12345,
        "fileStatus": 2,
        "viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
        "fileType": 7,
        "fileExst": ".txt",
        "comment": null,
        "id": 662558423,
        "title": "Some titile.txt",
        "access": 1,
        "shared": false,
        "rootFolderType": 2,
        "updatedBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "created": "2021-11-26T04:36:28.8390461Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2021-11-26T04:36:28.8390461Z"
      },
      {
        "folderId": 12334,
        "version": 3,
        "versionGroup": 1,
        "contentLength": "12.06 KB",
        "pureContentLength": 12345,
        "fileStatus": 2,
        "viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
        "fileType": 7,
        "fileExst": ".txt",
        "comment": null,
        "id": 662558423,
        "title": "Some titile.txt",
        "access": 1,
        "shared": false,
        "rootFolderType": 2,
        "updatedBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "created": "2021-11-26T04:36:28.8390461Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2021-11-26T04:36:28.8390461Z"
      }
    ],
    "folders": [
      {
        "parentId": 662558423,
        "filesCount": 662558423,
        "foldersCount": 662558423,
        "id": 662558423,
        "title": "Some titile",
        "access": 1,
        "shared": false,
        "rootFolderType": 2,
        "updatedBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "created": "2021-11-26T04:36:28.8390461Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2021-11-26T04:36:28.8390461Z"
      },
      {
        "parentId": 662558423,
        "filesCount": 662558423,
        "foldersCount": 662558423,
        "id": 662558423,
        "title": "Some titile",
        "access": 1,
        "shared": false,
        "rootFolderType": 2,
        "updatedBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "created": "2021-11-26T04:36:28.8390461Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2021-11-26T04:36:28.8390461Z"
      }
    ],
    "current": {
      "parentId": 662558423,
      "filesCount": 662558423,
      "foldersCount": 662558423,
      "id": 662558423,
      "title": "Some titile",
      "access": 1,
      "shared": false,
      "rootFolderType": 2,
      "updatedBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2021-11-26T04:36:28.8390461Z",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updated": "2021-11-26T04:36:28.8390461Z"
    },
    "pathParts": {
      "key": "Key",
      "path": "\/\/path\/\/to\/\/folder"
    },
    "startIndex": 0,
    "count": 4,
    "total": 4
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <files>
      <folderId>12334</folderId>
      <version>3</version>
      <versionGroup>1</versionGroup>
      <contentLength>12.06 KB</contentLength>
      <pureContentLength>12345</pureContentLength>
      <fileStatus>2</fileStatus>
      <viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
      <fileType>7</fileType>
      <fileExst>.txt</fileExst>
      <comment />
      <id>662558423</id>
      <title>Some titile.txt</title>
      <access>1</access>
      <shared>false</shared>
      <rootFolderType>2</rootFolderType>
      <updatedBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </updatedBy>
      <created>2021-11-26T04:36:28.8390461Z</created>
      <createdBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </createdBy>
      <updated>2021-11-26T04:36:28.8390461Z</updated>
    </files>
    <files>
      <folderId>12334</folderId>
      <version>3</version>
      <versionGroup>1</versionGroup>
      <contentLength>12.06 KB</contentLength>
      <pureContentLength>12345</pureContentLength>
      <fileStatus>2</fileStatus>
      <viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
      <fileType>7</fileType>
      <fileExst>.txt</fileExst>
      <comment />
      <id>662558423</id>
      <title>Some titile.txt</title>
      <access>1</access>
      <shared>false</shared>
      <rootFolderType>2</rootFolderType>
      <updatedBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </updatedBy>
      <created>2021-11-26T04:36:28.8390461Z</created>
      <createdBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </createdBy>
      <updated>2021-11-26T04:36:28.8390461Z</updated>
    </files>
    <folders>
      <parentId>662558423</parentId>
      <filesCount>662558423</filesCount>
      <foldersCount>662558423</foldersCount>
      <id>662558423</id>
      <title>Some titile</title>
      <access>1</access>
      <shared>false</shared>
      <rootFolderType>2</rootFolderType>
      <updatedBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </updatedBy>
      <created>2021-11-26T04:36:28.8390461Z</created>
      <createdBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </createdBy>
      <updated>2021-11-26T04:36:28.8390461Z</updated>
    </folders>
    <folders>
      <parentId>662558423</parentId>
      <filesCount>662558423</filesCount>
      <foldersCount>662558423</foldersCount>
      <id>662558423</id>
      <title>Some titile</title>
      <access>1</access>
      <shared>false</shared>
      <rootFolderType>2</rootFolderType>
      <updatedBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </updatedBy>
      <created>2021-11-26T04:36:28.8390461Z</created>
      <createdBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </createdBy>
      <updated>2021-11-26T04:36:28.8390461Z</updated>
    </folders>
    <current>
      <parentId>662558423</parentId>
      <filesCount>662558423</filesCount>
      <foldersCount>662558423</foldersCount>
      <id>662558423</id>
      <title>Some titile</title>
      <access>1</access>
      <shared>false</shared>
      <rootFolderType>2</rootFolderType>
      <updatedBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </updatedBy>
      <created>2021-11-26T04:36:28.8390461Z</created>
      <createdBy>
        <id>00000000-0000-0000-0000-000000000000</id>
        <displayName>Mike Zanyatski</displayName>
        <title>Manager</title>
        <avatarSmall>url to small avatar</avatarSmall>
        <profileUrl></profileUrl>
      </createdBy>
      <updated>2021-11-26T04:36:28.8390461Z</updated>
    </current>
    <pathParts>
      <key>Key</key>
      <path>//path//to//folder</path>
    </pathParts>
    <startIndex>0</startIndex>
    <count>4</count>
    <total>4</total>
  </response>
</result>