Loading ...

REST API: Get Forum Groups | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Forums » REST API: Forum Groups » REST API: Get Forum Groups
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 32

REST API: Get Forum Groups

0 
 /5
0 (0votes)
Open API Guide
GET/api/content/list

Retrieve a filtered list of forum groups from the intranet. Supports filtering by space, user, category, status, and keyword, with options for sorting and pagination.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
entityTypeStringYESQueryEntity Type for group is 2. Valid values: 1 = Wall Post, 2 = Poll, 3 = Article, 4 = Blog Entry, 5 = Wiki Page, 7 = File, 8 = Photo, 9 = Event, 10 = Forum Topic, 11 = Forum Post, 12 = Idea, 13 = Task, 14 = Case, 15 = Video, 16 = Message Thread, 18 = Badge, 19 = Course, 20 = Quiz, 21 = Question, 22 = Answer, 25 = Space Member, 29 = Space.

Optional Parameters

ParameterTypeRequiredLocationDescription
entityTypeCsvStringNOQuerySpecifies the entity type csv
contentTypeIDIntegerNOQueryThe unique identifier for the content type
categoryNameCsvStringNOQuerySpecifies the category name csv
categoryNameStringNOQuerySpecifies the category name
forMySpacesBooleanNOQueryFlag indicating whether for my spaces is enabled. Default: false.
showExpiredBooleanNOQueryFlag indicating whether show expired is enabled. Default: false.
parentContentIDIntegerNOQueryThe unique identifier for the parent content
categoryIDIntegerNOQueryThe unique identifier for the category
spaceIDIntegerNOQueryUnique ID of a space
spaceIDCsvStringNOQuerySpecifies the space ID csv
userIDIntegerNOQueryUnique ID of the user whose groups are to be returned
entityStatusStringNOQuerySpecifies the status of the forums to be returned. Non Active = 0 Active = 1 NOTE: If status is passed as NULL then all the forum groups are returned.
isFeaturedBooleanNOQueryFlag indicating whether featured is enabled
sortColumnStringNOQuerySpecifies the sort column
sortOrderStringNOQuerySpecifies the sort order
datePublishedTimeStringNOQueryReturns content that was published before the specified date time
startPageIntegerNOQuerySpecifies the starting page of list to be returned
pageLengthIntegerNOQuerySpecifies the number of results to be returned per page
isUnansweredBooleanNOQueryFlag indicating whether unanswered is enabled
markedAsAnswerBooleanNOQueryFlag indicating whether marked as answer is enabled
asGenericContentBooleanNOQueryFlag indicating whether as generic content is enabled. Default: false.
withCommentsBooleanNOQueryFlag indicating whether with comments is enabled. Default: false.
parseContentBodyMnemonicsBooleanNOQueryFlag indicating whether parse content body mnemonics is enabled. Default: false.
keywordStringNOQuerySpecifies the keyword
logViewBooleanNOQueryFlag indicating whether log view is enabled. Default: false.
cultureStringNOQuerySpecifies the culture

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/content/list?entityType=2&userID=1&spaceID=252&entityStatus=1&sortColumn=1&sortOrder=0&startPage=1&pageLength=3

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ContentID": 220,
      "EntityType": 1,
      "ContentTypeID": 2,
      "ContentTitle": "Venus Facts",
      "ContentStub": "venus-facts",
      "AuthorID": 1,
      "AuthorUserName": "jon",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "2026-01-01T12:00:00Z",
      "ContentVersionID": 1,
      "SpaceID": 252,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "ContentStageID": null,
      "ContentStageName": null,
      "DateCreated": "2026-01-01T12:00:00Z",
      "DatePublished": "2026-01-01T12:00:00Z",
      "DateUpdated": "2026-01-01T12:00:00Z",
      "IsFeatured": true,
      "SpaceName": null,
      "SpaceURL": null,
      "AuthorDisplayName": "Jon Smith",
      "AuthorEmail": "SampleEmail@your-site.com",
      "AuthorFirstName": "Jon",
      "AuthorLastName": "Smith",
      "AuthorProfileUrl": "http://your-site.com/people/jon",
      "LockedByUserProfileUrl": null,
      "LockedByUserDisplayName": null,
      "IsLatest": false,
      "DateCreatedString": "2026-01-01T12:00:00Z",
      "DatePublishedString": "2026-01-01T12:00:00Z",
      "DateUpdatedString": "2026-01-01T12:00:00Z"
    },
    {
      "ContentMediaBytes": null,
      "ContentID": 220,
      "EntityType": 1,
      "ContentTypeID": 2,
      "ContentTitle": "Mars Facts",
      "ContentStub": "mars-facts",
      "AuthorID": 1,
      "AuthorUserName": "jon",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "2026-01-01T12:00:00Z",
      "ContentVersionID": 1,
      "SpaceID": 252,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "ContentStageID": null,
      "ContentStageName": null,
      "DateCreated": "2026-01-01T12:00:00Z",
      "DatePublished": "2026-01-01T12:00:00Z",
      "DateUpdated": "2026-01-01T12:00:00Z",
      "SpaceName": null,
      "SpaceURL": null,
      "AuthorDisplayName": "Jon Smith",
      "AuthorEmail": "SampleEmail@your-site.com",
      "AuthorFirstName": "Jon",
      "AuthorLastName": "Smith",
      "AuthorProfileUrl": "http://your-site.com/people/jon",
      "LockedByUserProfileUrl": null,
      "LockedByUserDisplayName": null,
      "IsLatest": false,
      "TagsCSV": null,
      "TagsIDCSV": null,
      "DateCreatedString": "2026-01-01T12:00:00Z",
      "DatePublishedString": "2026-01-01T12:00:00Z",
      "DateUpdatedString": "2026-01-01T12:00:00Z"
    },
    {
      "ContentMediaBytes": null,
      "ContentID": 220,
      "EntityType": 1,
      "ContentTypeID": 2,
      "ContentTitle": "Jupiter Facts",
      "ContentStub": "jupiter-facts",
      "AuthorID": 1,
      "AuthorUserName": "jon",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "2026-01-01T12:00:00Z",
      "ContentVersionID": 1,
      "SpaceID": 252,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "ContentStageID": null,
      "ContentStageName": null,
      "DateCreated": "2026-01-01T12:00:00Z",
      "DatePublished": "2026-01-01T12:00:00Z",
      "DateUpdated": "2026-01-01T12:00:00Z",
      "SpaceName": null,
      "SpaceURL": null,
      "AuthorDisplayName": "Jon Smith",
      "AuthorEmail": "SampleEmail@your-site.com",
      "AuthorFirstName": "Jon",
      "AuthorLastName": "Smith",
      "AuthorProfileUrl": "http://your-site.com/people/jon",
      "LockedByUserProfileUrl": null,
      "LockedByUserDisplayName": null,
      "IsLatest": false,
      "DateCreatedString": "2026-01-01T12:00:00Z",
      "DatePublishedString": "2026-01-01T12:00:00Z",
      "DateUpdatedString": "2026-01-01T12:00:00Z"
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid.Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages