TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

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

Description

Returns a list of topics matching the search query specified in the request with the topic titles, dates of creation and update, post texts, and authors.

Parameters
Name Description Type Example
query
sent in url
Search query string some text
Example
GET api/2.0/community/forum/@search/%22some+text%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of topics

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": 10,
      "Title": "Sample topic",
      "Created": "2020-12-07T13:56:02.3259212Z",
      "Updated": "2020-12-07T13:56:02.3259212Z",
      "Text": "This is sample post",
      "UpdatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "ThreadTitile": null,
      "Status": 0,
      "Type": 0,
      "Tags": "Tag1,Tag2"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>10</Id>
    <Title>Sample topic</Title>
    <Created>2020-12-07T13:56:02.3259212Z</Created>
    <Updated>2020-12-07T13:56:02.3259212Z</Updated>
    <Text>This is sample post</Text>
    <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>
    <ThreadTitile />
    <Status>0</Status>
    <Type>0</Type>
    <Tags>Tag1,Tag2</Tags>
  </response>
</result>