List Forum REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:45:57 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:45:57

GET api.ashx/v2/forums.{json|xml}

LIST forums.

Scopes

Forums › Read Forums forums.forums.readonly

Request Parameters

Name	Type	Description	Required
ApplicationIds	string	Comma separated list of ApplicationIds. Used to limit to a specific set of forums as well as sort order if SortBy is set to ApplicationIdsOrder	Optional
GroupId	int?	Group Id	Optional
IncludeSubGroups	bool?	Only used when GroupId is specified. Default is false.	Optional
PageIndex	int?	Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.	Optional
PageSize	int?	Specify the number of results to return per page. If not set the default is 20. The max is 100.	Optional
PermissionId	string	Used to get a list of forums for which the accessing or impersonated user has the provided Permission for.	Optional
SortBy	string	Options are: DateCreated, LastPost, Name, Post, SortOrder, Thread, TotalPosts. Default is SortOrder.	Optional
SortOrder	string	Options include Ascending, Descending. Default is Ascending.	Optional
UserId	int?	Obsolete in 9.2: User Id should no longer be used. Rely on the authenticated or impersonated user instead	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/forums.json'
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "Forums": [
    {
      "Name": "title",
      "Title": "title",
      "Url": "url",
      "Group": {
        "AvatarUrl": "avatarurl",
        "DateCreated": "2012-01-04T00:00:00",
        "Description": "description",
        "Key": "key",
        "Name": "name",
        "ParentGroupId": 6,
        "Url": "url",
        "TotalMembers": 25,
        "HasGroups": true,
        "GroupCount": 8,
        "GroupType": "grouptype",
        "EnableGroupMessages": true,
        "EnableContact": true,
        "SearchUniqueId": "searchuniqueid",
        "IsEnabled": true,
        "ExtendedAttributes": [
          {
            "Key": "key",
            "Value": "value"
          },
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
        "Container": {
          "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
          "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        },
        "Id": 4
      },
      "DateCreated": "2012-05-02T00:00:00",
      "LatestPostDate": "2012-06-04T00:00:00",
      "Description": "description",
      "AllowedThreadTypes": [
        {
          "Value": "value"
        },
        {
          "Value": "value"
        }
      ],
      "DefaultThreadType": "defaultthreadtype",
      "Enabled": true,
      "IndexPosts": true,
      "Key": "key",
      "ModeratePosts": true,
      "EnablePostStatistics": true,
      "EnableQualityVoting": true,
      "EnablePostPoints": true,
      "PostsToModerate": 7,
      "ThreadCount": 27,
      "ReplyCount": 32,
      "EmailAddress": "emailaddress",
      "EnableAnonymousPosting": true,
      "DefaultThreadStatus": "defaultthreadstatus",
      "SearchUniqueId": "searchuniqueid",
      "SuggestedAnswerVoteThreshold": 52,
      "VerifiedAnswerVoteThreshold": 19,
      "AutoLockingEnabled": true,
      "AutoLockingDefaultInterval": 112,
      "Application": {
        "ApplicationId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
        "ApplicationTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
        "HtmlName": "htmlname",
        "HtmlDescription": "htmldescription",
        "Url": "url",
        "AvatarUrl": "avatarurl",
        "Container": {
          "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
          "ContainerTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        }
      },
      "ExtendedAttributes": [
        {
          "Key": "key",
          "Value": "value"
        },
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "Id": 61
    },
    {
      "Name": "title",
      "Title": "title",
      "Url": "url",
      "Group": {
        "AvatarUrl": "avatarurl",
        "DateCreated": "2011-05-28T00:00:00",
        "Description": "description",
        "Key": "key",
        "Name": "name",
        "ParentGroupId": 18,
        "Url": "url",
        "TotalMembers": 76,
        "HasGroups": true,
        "GroupCount": 6,
        "GroupType": "grouptype",
        "EnableGroupMessages": true,
        "EnableContact": true,
        "SearchUniqueId": "searchuniqueid",
        "IsEnabled": true,
        "ExtendedAttributes": [
          {
            "Key": "key",
            "Value": "value"
          },
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "ContainerId": "6cdcf200-3bad-476d-af45-97b52545c337",
        "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
        "Container": {
          "ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
          "ContainerTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        },
        "Id": 25
      },
      "DateCreated": "2011-12-09T00:00:00",
      "LatestPostDate": "2012-03-29T00:00:00",
      "Description": "description",
      "AllowedThreadTypes": [
        {
          "Value": "value"
        },
        {
          "Value": "value"
        }
      ],
      "DefaultThreadType": "defaultthreadtype",
      "Enabled": true,
      "IndexPosts": true,
      "Key": "key",
      "ModeratePosts": true,
      "EnablePostStatistics": true,
      "EnableQualityVoting": true,
      "EnablePostPoints": true,
      "PostsToModerate": 8,
      "ThreadCount": 4,
      "ReplyCount": 7,
      "EmailAddress": "emailaddress",
      "EnableAnonymousPosting": true,
      "DefaultThreadStatus": "defaultthreadstatus",
      "SearchUniqueId": "searchuniqueid",
      "SuggestedAnswerVoteThreshold": 27,
      "VerifiedAnswerVoteThreshold": 32,
      "AutoLockingEnabled": true,
      "AutoLockingDefaultInterval": 52,
      "Application": {
        "ApplicationId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "ApplicationTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "HtmlName": "htmlname",
        "HtmlDescription": "htmldescription",
        "Url": "url",
        "AvatarUrl": "avatarurl",
        "Container": {
          "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
          "ContainerTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        }
      },
      "ExtendedAttributes": [
        {
          "Key": "key",
          "Value": "value"
        },
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "Id": 19
    }
  ],
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Forums PageSize="2" PageIndex="0" TotalCount="2">
    <Forum>
      <Id>61</Id>
      <Name>title</Name>
      <Url>url</Url>
      <Group>
        <Id>4</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DateCreated>2012-01-04T00:00:00</DateCreated>
        <Description>description</Description>
        <Key>key</Key>
        <Name>name</Name>
        <ParentGroupId>6</ParentGroupId>
        <Url>url</Url>
        <TotalMembers>25</TotalMembers>
        <HasGroups>true</HasGroups>
        <GroupCount>8</GroupCount>
        <GroupType>grouptype</GroupType>
        <EnableGroupMessages>true</EnableGroupMessages>
        <EnableContact>true</EnableContact>
        <SearchUniqueId>searchuniqueid</SearchUniqueId>
        <ExtendedAttributes>
          <key>value</key>
          <key>value</key>
        </ExtendedAttributes>
        <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
        <Container>
          <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
          <ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Group>
      <DateCreated>2012-05-02T00:00:00</DateCreated>
      <LatestPostDate>2012-06-04T00:00:00</LatestPostDate>
      <Description>description</Description>
      <AllowedThreadTypes>
        <ThreadType>value</ThreadType>
        <ThreadType>value</ThreadType>
      </AllowedThreadTypes>
      <DefaultThreadType>defaultthreadtype</DefaultThreadType>
      <Enabled>true</Enabled>
      <IndexPosts>true</IndexPosts>
      <Key>key</Key>
      <ModeratePosts>true</ModeratePosts>
      <EnablePostStatistics>true</EnablePostStatistics>
      <EnableQualityVoting>true</EnableQualityVoting>
      <PostsToModerate>7</PostsToModerate>
      <ThreadCount>27</ThreadCount>
      <ReplyCount>32</ReplyCount>
      <EmailAddress>emailaddress</EmailAddress>
      <EnableAnonymousPosting>true</EnableAnonymousPosting>
      <DefaultThreadStatus>defaultthreadstatus</DefaultThreadStatus>
      <SearchUniqueId>searchuniqueid</SearchUniqueId>
      <SuggestedAnswerVoteThreshold>52</SuggestedAnswerVoteThreshold>
      <VerifiedAnswerVoteThreshold>19</VerifiedAnswerVoteThreshold>
      <AutoLockingEnabled>true</AutoLockingEnabled>
      <AutoLockingDefaultInterval>112</AutoLockingDefaultInterval>
      <Application>
        <ApplicationId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationId>
        <ApplicationTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ApplicationTypeId>
        <HtmlName>htmlname</HtmlName>
        <HtmlDescription>htmldescription</HtmlDescription>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
        <Container>
          <ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId>
          <ContainerTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Application>
      <ExtendedAttributes>
        <key>value</key>
        <key>value</key>
      </ExtendedAttributes>
    </Forum>
    <Forum>
      <Id>19</Id>
      <Name>title</Name>
      <Url>url</Url>
      <Group>
        <Id>25</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DateCreated>2011-05-28T00:00:00</DateCreated>
        <Description>description</Description>
        <Key>key</Key>
        <Name>name</Name>
        <ParentGroupId>18</ParentGroupId>
        <Url>url</Url>
        <TotalMembers>76</TotalMembers>
        <HasGroups>true</HasGroups>
        <GroupCount>6</GroupCount>
        <GroupType>grouptype</GroupType>
        <EnableGroupMessages>true</EnableGroupMessages>
        <EnableContact>true</EnableContact>
        <SearchUniqueId>searchuniqueid</SearchUniqueId>
        <ExtendedAttributes>
          <key>value</key>
          <key>value</key>
        </ExtendedAttributes>
        <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
        <Container>
          <ContainerId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerId>
          <ContainerTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Group>
      <DateCreated>2011-12-09T00:00:00</DateCreated>
      <LatestPostDate>2012-03-29T00:00:00</LatestPostDate>
      <Description>description</Description>
      <AllowedThreadTypes>
        <ThreadType>value</ThreadType>
        <ThreadType>value</ThreadType>
      </AllowedThreadTypes>
      <DefaultThreadType>defaultthreadtype</DefaultThreadType>
      <Enabled>true</Enabled>
      <IndexPosts>true</IndexPosts>
      <Key>key</Key>
      <ModeratePosts>true</ModeratePosts>
      <EnablePostStatistics>true</EnablePostStatistics>
      <EnableQualityVoting>true</EnableQualityVoting>
      <PostsToModerate>8</PostsToModerate>
      <ThreadCount>4</ThreadCount>
      <ReplyCount>7</ReplyCount>
      <EmailAddress>emailaddress</EmailAddress>
      <EnableAnonymousPosting>true</EnableAnonymousPosting>
      <DefaultThreadStatus>defaultthreadstatus</DefaultThreadStatus>
      <SearchUniqueId>searchuniqueid</SearchUniqueId>
      <SuggestedAnswerVoteThreshold>27</SuggestedAnswerVoteThreshold>
      <VerifiedAnswerVoteThreshold>32</VerifiedAnswerVoteThreshold>
      <AutoLockingEnabled>true</AutoLockingEnabled>
      <AutoLockingDefaultInterval>52</AutoLockingDefaultInterval>
      <Application>
        <ApplicationId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationId>
        <ApplicationTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationTypeId>
        <HtmlName>htmlname</HtmlName>
        <HtmlDescription>htmldescription</HtmlDescription>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
        <Container>
          <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
          <ContainerTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Application>
      <ExtendedAttributes>
        <key>value</key>
        <key>value</key>
      </ExtendedAttributes>
    </Forum>
  </Forums>
</Response>