Get Started
Usage API
More information

GET api/2.0/files/folder/{folderId} This function requires authentication

Description

Returns the detailed information about a folder with the ID specified in the request.

Parameters
Name Description Type Example
folderId
sent in url
Folder ID string some text
Example
GET api/2.0/files/folder/some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Folder information

Example Response

application/json

{
  "status": 0,
  "response": {
    "parentId": 281758750,
    "filesCount": 281758750,
    "foldersCount": 281758750,
    "id": 281758750,
    "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": "2022-05-25T16:33:49.2829465Z",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updated": "2022-05-25T16:33:49.2829465Z"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <parentId>281758750</parentId>
    <filesCount>281758750</filesCount>
    <foldersCount>281758750</foldersCount>
    <id>281758750</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>2022-05-25T16:33:49.2829465Z</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>2022-05-25T16:33:49.2829465Z</updated>
  </response>
</result>