Get Started
Usage API
More information

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

Description

Returns all the sections matching the parameters specified in the request.

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
searchInContent
sent in url
 Search in content files Bool value true
withSubfolders
sent in url
 Root folders with or without subfolders Bool value true
withoutTrash
sent in url
 Root folders with or without trash Bool value true
withoutAdditionalFolder
sent in url
 Root folders with or without additional folders Bool value true
Example
GET api/2.0/files/@root?userIdOrGroupId=9924256A-739C-462b-AF15-E652A3B1B6EB&filterType=none&searchInContent=True&withSubfolders=True&withoutTrash=True&withoutAdditionalFolder=True
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Sections

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": 1547656026,
          "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": "2023-02-01T01:35:46.5098276Z",
          "createdBy": {
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Mike Zanyatski",
            "title": "Manager",
            "avatarSmall": "url to small avatar",
            "profileUrl": ""
          },
          "updated": "2023-02-01T01:35:46.5098276Z"
        },
        {
          "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": 1547656026,
          "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": "2023-02-01T01:35:46.5098276Z",
          "createdBy": {
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Mike Zanyatski",
            "title": "Manager",
            "avatarSmall": "url to small avatar",
            "profileUrl": ""
          },
          "updated": "2023-02-01T01:35:46.5098276Z"
        }
      ],
      "folders": [
        {
          "parentId": 1547656026,
          "filesCount": 1547656026,
          "foldersCount": 1547656026,
          "id": 1547656026,
          "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": "2023-02-01T01:35:46.5098276Z",
          "createdBy": {
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Mike Zanyatski",
            "title": "Manager",
            "avatarSmall": "url to small avatar",
            "profileUrl": ""
          },
          "updated": "2023-02-01T01:35:46.5098276Z"
        },
        {
          "parentId": 1547656026,
          "filesCount": 1547656026,
          "foldersCount": 1547656026,
          "id": 1547656026,
          "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": "2023-02-01T01:35:46.5098276Z",
          "createdBy": {
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Mike Zanyatski",
            "title": "Manager",
            "avatarSmall": "url to small avatar",
            "profileUrl": ""
          },
          "updated": "2023-02-01T01:35:46.5098276Z"
        }
      ],
      "current": {
        "parentId": 1547656026,
        "filesCount": 1547656026,
        "foldersCount": 1547656026,
        "id": 1547656026,
        "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": "2023-02-01T01:35:46.5098276Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2023-02-01T01:35:46.5098276Z"
      },
      "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>1547656026</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>2023-02-01T01:35:46.5098276Z</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>2023-02-01T01:35:46.5098276Z</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>1547656026</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>2023-02-01T01:35:46.5098276Z</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>2023-02-01T01:35:46.5098276Z</updated>
    </files>
    <folders>
      <parentId>1547656026</parentId>
      <filesCount>1547656026</filesCount>
      <foldersCount>1547656026</foldersCount>
      <id>1547656026</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>2023-02-01T01:35:46.5098276Z</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>2023-02-01T01:35:46.5098276Z</updated>
    </folders>
    <folders>
      <parentId>1547656026</parentId>
      <filesCount>1547656026</filesCount>
      <foldersCount>1547656026</foldersCount>
      <id>1547656026</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>2023-02-01T01:35:46.5098276Z</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>2023-02-01T01:35:46.5098276Z</updated>
    </folders>
    <current>
      <parentId>1547656026</parentId>
      <filesCount>1547656026</filesCount>
      <foldersCount>1547656026</foldersCount>
      <id>1547656026</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>2023-02-01T01:35:46.5098276Z</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>2023-02-01T01:35:46.5098276Z</updated>
    </current>
    <pathParts>
      <key>Key</key>
      <path>//path//to//folder</path>
    </pathParts>
    <startIndex>0</startIndex>
    <count>4</count>
    <total>4</total>
  </response>
</result>
© Ascensio System SIA 2023. All rights reserved