Get Started
Portal api methods
Help

GET api/2.0/community/forum This function requires authentication

Description

Returns the list of all forums created on the portal with the topic/thread titles, date of creation and update, post text and author ID and display name

Parameters

This method doesn't have any parameters

Example
GET api/2.0/community/forum
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of forums

Example Response

application/json

{
  "status": 0,
  "response": {
    "categories": [
      {
        "id": 0,
        "title": "Sample title",
        "created": "2019-10-15T09:54:26.7836886Z",
        "updated": "2019-10-15T09:54:26.7846606Z",
        "description": "Sample category",
        "threads": [
          {
            "id": 10,
            "title": "The Thread",
            "updatedBy": {
              "id": "00000000-0000-0000-0000-000000000000",
              "displayName": "Mike Zanyatski",
              "title": "Manager",
              "avatarSmall": "url to small avatar",
              "profileUrl": ""
            },
            "description": "Sample thread",
            "created": "2019-10-15T09:54:26.7846606Z",
            "updated": "2019-10-15T09:54:26.7846606Z",
            "recentTopicId": 1234,
            "recentTopicTitle": "Sample topic"
          }
        ]
      }
    ]
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <categories>
      <id>0</id>
      <title>Sample title</title>
      <created>2019-10-15T09:54:26.7836886Z</created>
      <updated>2019-10-15T09:54:26.7846606Z</updated>
      <description>Sample category</description>
      <threads>
        <id>10</id>
        <title>The Thread</title>
        <updatedBy>
          <id>00000000-0000-0000-0000-000000000000</id>
          <displayName>Mike Zanyatski</displayName>
          <title>Manager</title>
          <avatarSmall>url to small avatar</avatarSmall>
          <profileUrl></profileUrl>
        </updatedBy>
        <description>Sample thread</description>
        <created>2019-10-15T09:54:26.7846606Z</created>
        <updated>2019-10-15T09:54:26.7846606Z</updated>
        <recentTopicId>1234</recentTopicId>
        <recentTopicTitle>Sample topic</recentTopicTitle>
      </threads>
    </categories>
  </response>
</result>