Get Started
Usage API
More information

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

Description

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

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

File information

Example Response

application/json

{
  "status": 0,
  "response": {
    "folderId": 12334,
    "version": 3,
    "versionGroup": 1,
    "contentLength": "12.06 KB",
    "pureContentLength": 12345,
    "fileStatus": 2,
    "viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
    "fileType": 7,
    "fileExst": ".txt",
    "comment": null,
    "id": 1310987167,
    "title": "Some titile.txt",
    "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": "2021-10-27T06:29:16.8892668Z",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updated": "2021-10-27T06:29:16.8892668Z"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <folderId>12334</folderId>
    <version>3</version>
    <versionGroup>1</versionGroup>
    <contentLength>12.06 KB</contentLength>
    <pureContentLength>12345</pureContentLength>
    <fileStatus>2</fileStatus>
    <viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
    <fileType>7</fileType>
    <fileExst>.txt</fileExst>
    <comment />
    <id>1310987167</id>
    <title>Some titile.txt</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>2021-10-27T06:29:16.8892668Z</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>2021-10-27T06:29:16.8892668Z</updated>
  </response>
</result>