GET api/2.0/files/file/{fileId}/share This function requires authentication

Description

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

Parameters
Name Description Type Example
fileId
sent in url
File ID string some text
Example
GET api/2.0/files/file/%22some+text%22/share
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Shared file 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 />
    </SharedTo>
    <IsLocked>False</IsLocked>
    <IsOwner>True</IsOwner>
  </response>
</result>