Get Started
Portal api methods
Help

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

Description

Returns the detailed information about shared 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/share
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Shared folder information

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "access": 1,
      "sharedTo": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "isLocked": false,
      "isOwner": true
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <access>1</access>
    <sharedTo>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </sharedTo>
    <isLocked>false</isLocked>
    <isOwner>true</isOwner>
  </response>
</result>