Get Started
Portal api methods
Help

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

Description

Returns the detailed list of files and folders located in the current user 'Projects Documents' section

Parameters

This method doesn't have any parameters

Example
GET api/2.0/files/@projects
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Projects folder contents

Example Response

application/json

{
  "status": 0,
  "response": {
    "files": [
      {
        "folderId": 12334,
        "version": 3,
        "versionGroup": 1,
        "contentLength": "12345",
        "fileStatus": 2,
        "viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
        "fileType": 7,
        "fileExst": ".txt",
        "comment": null,
        "id": 1272255774,
        "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": "2019-06-23T18:26:27.0907185Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2019-06-23T18:26:27.0907185Z",
        "providerItem": false
      },
      {
        "folderId": 12334,
        "version": 3,
        "versionGroup": 1,
        "contentLength": "12345",
        "fileStatus": 2,
        "viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
        "fileType": 7,
        "fileExst": ".txt",
        "comment": null,
        "id": 1272255774,
        "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": "2019-06-23T18:26:27.0907185Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2019-06-23T18:26:27.0907185Z",
        "providerItem": false
      }
    ],
    "folders": [
      {
        "parentId": 1272255774,
        "filesCount": 1272255774,
        "foldersCount": 1272255774,
        "id": 1272255774,
        "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": "2019-06-23T18:26:27.0907185Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2019-06-23T18:26:27.0907185Z",
        "providerItem": false
      },
      {
        "parentId": 1272255774,
        "filesCount": 1272255774,
        "foldersCount": 1272255774,
        "id": 1272255774,
        "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": "2019-06-23T18:26:27.0907185Z",
        "createdBy": {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        },
        "updated": "2019-06-23T18:26:27.0907185Z",
        "providerItem": false
      }
    ],
    "current": {
      "parentId": 1272255774,
      "filesCount": 1272255774,
      "foldersCount": 1272255774,
      "id": 1272255774,
      "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": "2019-06-23T18:26:27.0907185Z",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updated": "2019-06-23T18:26:27.0907185Z",
      "providerItem": false
    },
    "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>12345</contentLength>
      <fileStatus>2</fileStatus>
      <viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
      <fileType>7</fileType>
      <fileExst>.txt</fileExst>
      <comment />
      <id>1272255774</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>2019-06-23T18:26:27.0907185Z</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>2019-06-23T18:26:27.0907185Z</updated>
      <providerItem>false</providerItem>
    </files>
    <files>
      <folderId>12334</folderId>
      <version>3</version>
      <versionGroup>1</versionGroup>
      <contentLength>12345</contentLength>
      <fileStatus>2</fileStatus>
      <viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
      <fileType>7</fileType>
      <fileExst>.txt</fileExst>
      <comment />
      <id>1272255774</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>2019-06-23T18:26:27.0907185Z</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>2019-06-23T18:26:27.0907185Z</updated>
      <providerItem>false</providerItem>
    </files>
    <folders>
      <parentId>1272255774</parentId>
      <filesCount>1272255774</filesCount>
      <foldersCount>1272255774</foldersCount>
      <id>1272255774</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>2019-06-23T18:26:27.0907185Z</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>2019-06-23T18:26:27.0907185Z</updated>
      <providerItem>false</providerItem>
    </folders>
    <folders>
      <parentId>1272255774</parentId>
      <filesCount>1272255774</filesCount>
      <foldersCount>1272255774</foldersCount>
      <id>1272255774</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>2019-06-23T18:26:27.0907185Z</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>2019-06-23T18:26:27.0907185Z</updated>
      <providerItem>false</providerItem>
    </folders>
    <current>
      <parentId>1272255774</parentId>
      <filesCount>1272255774</filesCount>
      <foldersCount>1272255774</foldersCount>
      <id>1272255774</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>2019-06-23T18:26:27.0907185Z</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>2019-06-23T18:26:27.0907185Z</updated>
      <providerItem>false</providerItem>
    </current>
    <pathParts>
      <key>Key</key>
      <path>//path//to//folder</path>
    </pathParts>
    <startIndex>0</startIndex>
    <count>4</count>
    <total>4</total>
  </response>
</result>