GET api/2.0/files/@search/{query} This function requires authentication

Searches for files and folders by the query specified in the request.

GET api/2.0/files/@search/%22some+text%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Files and folders

application/json

{
  "status": 0,
  "response": [
    {
      "RootFolderType": 2,
      "UpdatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "Created": "2020-12-13T17:13:31.5902727Z",
      "CreatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "Updated": "2020-12-13T17:13:31.5902727Z",
      "ProviderItem": true,
      "ProviderKey": "1234d",
      "ProviderId": 1234,
      "FolderId": 12334,
      "Version": 3,
      "VersionGroup": 1,
      "ContentLength": "12.06 KB",
      "PureContentLength": 12345,
      "FileStatus": 2,
      "ViewUrl": "http:\\/\\/www.onlyoffice.com\\/viewfile?fileid=2221",
      "WebUrl": "http:\\/\\/www.onlyoffice.com\\/viewfile?fileid=2221",
      "FileType": 7,
      "FileExst": ".txt",
      "Comment": null,
      "Encrypted": true,
      "Id": 857864274,
      "Title": "Some titile.txt",
      "Access": 1,
      "Shared": false
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <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>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </UpdatedBy>
    <Created>2020-12-13T17:13:31.5902727Z</Created>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <Updated>2020-12-13T17:13:31.5902727Z</Updated>
    <ProviderItem>True</ProviderItem>
    <ProviderKey>1234d</ProviderKey>
    <ProviderId>1234</ProviderId>
    <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>
    <WebUrl>http:\/\/www.onlyoffice.com\/viewfile?fileid=2221</WebUrl>
    <FileType>7</FileType>
    <FileExst>.txt</FileExst>
    <Comment />
    <Encrypted>True</Encrypted>
    <Id>857864274</Id>
    <Title>Some titile.txt</Title>
    <Access>1</Access>
    <Shared>False</Shared>
  </response>
</result>