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/{threadid} This function requires authentication

Description

Returns a list of all the thread topics with the topic titles, dates of creation and update, post texts, and authors.

Parameters
Name Description Type Example
threadid
sent in url
Thread ID number 1234
Example
GET api/2.0/community/forum/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of thread topics

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": 10,
    "Title": "The Thread",
    "UpdatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Description": "Sample thread",
    "Created": "2020-12-07T13:56:02.3249197Z",
    "Updated": "2020-12-07T13:56:02.3249197Z",
    "RecentTopicTitle": "Sample topic",
    "Topics": [
      {
        "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"
      }
    ],
    "RecentTopicId": 1234
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <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>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </UpdatedBy>
    <Description>Sample thread</Description>
    <Created>2020-12-07T13:56:02.3249197Z</Created>
    <Updated>2020-12-07T13:56:02.3249197Z</Updated>
    <RecentTopicTitle>Sample topic</RecentTopicTitle>
    <Topics>
      <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>
    </Topics>
    <RecentTopicId>1234</RecentTopicId>
  </response>
</result>