Get Started
API backend
API system
More information

POST api/2.0/files/share This function requires authentication

Description

Returns the sharing rights for all the files and folders specified in the request.

Parameters
Name Description Type Example
FolderIds
sent in body
List of folder IDs System.Collections.Generic.IEnumerable{System.Text.Json.JsonElement}
FileIds
sent in body
List of file IDs System.Collections.Generic.IEnumerable{System.Text.Json.JsonElement}
Example
POST api/2.0/files/share
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of shared files and folders 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>