Get Started
API backend
API system
More information

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

Description

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

Parameters
Name Description Type Example
folderId
sent in url
Folder ID `0
Example
GET api/2.0/files/folder/{folderid}/share
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of shared folder information

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Access": "ReadWrite",
      "IsLocked": true,
      "IsOwner": true,
      "CanEditAccess": true
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Access>ReadWrite</Access>
    <IsLocked>True</IsLocked>
    <IsOwner>True</IsOwner>
    <CanEditAccess>True</CanEditAccess>
  </response>
</result>