Get Started
Portal api methods
Help

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

Description

Returns a list of topics matching the search query with the topic title, date of creation and update, post text and author

Parameters
Name Description Type Example
query
sent in url
Search query string some text
Example
GET api/2.0/community/forum/@search/some+text
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": "2019-12-12T20:36:51.5493569Z",
      "updated": "2019-12-12T20:36:51.5493569Z",
      "text": "This is sample post",
      "updatedBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "threadTitile": null,
      "status": 2,
      "type": 0,
      "tags": [
        "Tag1",
        "Tag2"
      ]
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>10</id>
    <title>Sample topic</title>
    <created>2019-12-12T20:36:51.5493569Z</created>
    <updated>2019-12-12T20:36:51.5493569Z</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></profileUrl>
    </updatedBy>
    <threadTitile />
    <status>2</status>
    <type>0</type>
    <tags>Tag1</tags>
    <tags>Tag2</tags>
  </response>
</result>