Get Started
Usage API
More information

GET api/2.0/crm/{entityType}/{entityid}/files This function requires authentication

Description

Returns a list of all the files for the entity with the ID and type specified in the request.

Parameters
Name Description Type Example
entityType
sent in url
Entity type string some text
entityid
sent in url
Entity ID number 1234
Example
GET api/2.0/crm/some+text/1234/files
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of files

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": 785854563,
      "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-21T12:03:55.5222659Z",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updated": "2021-10-21T12:03:55.5222659Z"
    }
  ]
}

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>785854563</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-21T12:03:55.5222659Z</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-21T12:03:55.5222659Z</updated>
  </response>
</result>