Loading ...

REST API: Get Content List | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Get Content List
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 74

REST API: Get Content List

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

Get a list of content items. Supported content types: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, Forum Posts.

Request

Request Header

Header Required Value Description
Authorization YES Bearer YOUR_TOKEN Bearer token for the authenticated user. Learn how to create Bearer tokens.

Optional Parameters

Parameter Type Required Location Description
EntityType String NO Query The entity type of the content to be returned. Values: Forum = 1, ForumGroup = 2, Article = 3, Blog = 4, Photo = 6, Video = 7, Wiki = 9, CMSPage = 12, File = 14, Album = 18, Idea = 44, ForumPost = 54, ForumTopic = 55. This parameter takes a single value. A short comma-separated value such as 3,4 answers HTTP 500 with an empty body. A long list such as 1,3,4,5,9,14,15,18,44,54,55,97, or a value that is not a number at all, is ignored. The filter is dropped, and every entity type in scope is returned with no error. Use EntityTypeCSV for a list.
EntityTypeCSV String NO Query Comma-separated list of entity types to return, using the same values as EntityType. For example, EntityTypeCSV=3,4 returns articles and blogs. When both this parameter and EntityType are supplied, both filters apply rather than one taking precedence. Two values that do not match each other then return no results. A value that is not a list of numbers answers HTTP 500 with an empty body.
CategoryID Integer NO Query Category ID for Articles, Blogs, Videos, CMS Pages & Ideas. A value that is not a number is ignored.
ParentContentID Integer NO Query Parent ID of the content. Used to get Topics in a Forum. A value that is not a number is ignored.
SpaceID Integer NO Query Unique ID of the space from which the content is to be returned. Leave it out to get content from every space you can access. A value that is not a number is ignored.
UserID Integer NO Query Unique ID of the author whose content is returned. A value that is not a number is ignored.
EntityStatus String NO Query Status of the content. Values: PendingWorkflow = 0, Published = 1, Draft = 2, Declined = 3, Updated = 4, Expired = 5, Spam = 6, All = 7, DelayedPublishing = 8, TemporarilySaved = 9, UnderProcessing = 10, Deleted = 11, Disabled = 12, ToBeDeleted = 13, Deactivated = 14, ProcessingFailed = 15. Omit it to return content in every status, deleted items included. A comma-separated value such as 1,2 answers HTTP 500 with an empty body; a value that is not a number is ignored.
EntityStatusCSV String NO Query Comma-separated list of content statuses to return. Uses the same status values as EntityStatus. For example, EntityStatusCSV=1,5 returns both Published and Expired content. When both EntityStatusCSV and EntityStatus are supplied, EntityStatusCSV takes precedence. If EntityStatusCSV contains a value that is not a number or is otherwise invalid, it is ignored and the request falls back to EntityStatus. If neither is valid, every status is returned. The request does not fail either way.
IsFeatured Boolean NO Query Used to get content marked as "featured." A value that is not true or false is ignored.
DatePublishedTime String NO Query Returns content that was published before this date and time. A value that is not a date answers HTTP 500 with an empty body.
CategoryName String NO Query Name of a category, as it appears on screen (not the category's web address). Returns items in that category. It takes one name. A comma-separated list such as News,Events is not split, so it returns only items in a category named exactly that, usually none.
CategoryNameCSV String NO Query Comma-separated category names. Sent without CategoryName, it does not filter by name. Every item that has a category is returned, whatever names it lists. Sent with CategoryName, items in either are returned.
MarkedAsAnswer Boolean NO Query Set it to true to get only answered discussion topics; otherwise send false. A value that is not true or false is ignored.
ForMySpaces Boolean NO Query Set to true to return only content from spaces the calling user is a member of; SpaceID is then ignored. A value that is not true or false is read as false.
ShowExpired Boolean NO Query Set to true to include content that has expired and is hidden. A value that is not true or false is read as false.
SortColumn String NO Query Column to sort by. The values that work on this list are DateCreated = 1 (the default), Rating = 2, DatePublished = 3, DateUpdated = 4, ViewCount = 5, CommentCount = 6, SortOrder = 8 (when SortOrder is set for the content), VoteCount = 9, ContentTitle = 10, and DateExpired = 17. Any other number, and a comma-separated value, answers HTTP 500 with an empty body; a value that is not a number is ignored.
SortOrder String NO Query The order in which content is to be sorted: Ascending = 0, Descending = 1. Default: descending. A comma-separated value answers HTTP 500 with an empty body; any other value is read as descending.
StartPage String NO Query Page number to return, as a whole number. Default: 1. A comma-separated value answers HTTP 500 with an empty body; any other value that is not a whole number is ignored.
PageLength String NO Query Number of results per page, as a whole number. Default: 25. A comma-separated value answers HTTP 500 with an empty body; any other value that is not a whole number is ignored.
LogView Boolean NO Query Logs the API call as an action in User Activity when set to true
Culture String NO Query Culture (language and region) of the translation to return, such as es-ES (Spain) or en-US (United States).
ContentTypeID Integer NO Query ID of a custom content type. Sending it replaces EntityType with a filter for custom content, so a built-in type ID such as 9 returns nothing. A value that is not a number is ignored.
SpaceIDCsv String NO Query Comma-separated list of space IDs to filter content from multiple spaces. With SpaceID, both filters apply. A value that is not a list of numbers answers HTTP 500 with an empty body.
IsUnanswered Boolean NO Query Set to true to return only unanswered discussion topics. A value that is not true or false is ignored.
AsGenericContent Boolean NO Query Set to true to return results as generic content objects instead of typed entities. The response then has no TotalRecords.
WithComments Boolean NO Query Set to true to include comments with each content item in the response
ParseContentBodyMnemonics Boolean NO Query Set to true to process mnemonics in the content body before returning
Keyword String NO Query Text matched against the title of each item. Body text is not searched.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/content/list?entityType=9&spaceID=313&pageLength=1

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "TotalRecords": 3,
  "ResponseData": [
    {
      "ContentID": 11943,
      "EntityType": 9,
      "ContentTypeID": 9,
      "ContentTitle": "Onboarding guide",
      "ContentStub": "onboarding-guide",
      "ContentBody": "Start here for your first week.",
      "ContentBodyUnprocessed": "Start here for your first week.",
      "ContentSummary": "Start here for your first week.",
      "AuthorID": 630,
      "AuthorUserName": "jane.doe",
      "UpdatedByUserID": 630,
      "UpdatedByUserDisplayName": "Jane Doe",
      "UpdatedByUserUsername": "jane.doe",
      "UpdatedByUserEmail": "jane.doe@your-site.com",
      "UpdatedByUserFirstName": "Jane",
      "UpdatedByUserLastName": "Doe",
      "UpdatedByUserAvatarImageUrl": "https://your-site.com/Assets/Uploaded-Photos/630/avatar.jpg",
      "UpdatedByUserProfileUrl": "https://your-site.com/people/jane.doe",
      "ParentContentID": 0,
      "ContentVersionID": "2",
      "SpaceID": 313,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "DateCreated": "2026-09-27T00:15:27.713",
      "DatePublished": "2026-09-27T00:15:27.73",
      "DateUpdated": "2026-09-27T00:46:57.423",
      "IsFeatured": false,
      "ViewCount": 0,
      "DownloadCount": 0,
      "CommentCount": 1,
      "Rating": 0.0,
      "MetaTitle": "onboarding-guide",
      "MetaDescription": "Start here for your first week.",
      "MetaKeywords": "",
      "SortOrder": 3,
      "PageH1Content": "",
      "HeadCustomContent": "",
      "SideBarContent": "",
      "ContentExternalID": "",
      "ExtraSideBarContent": "",
      "ExternalURL": "",
      "AllowAnonymousComments": false,
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 90,
      "ExternalContentType": 0,
      "ContentMediaServerRootURL": "https://your-site.com/Assets/Uploaded-CMS-Files",
      "SpaceName": "Product Team",
      "SpaceURL": "https://your-site.com/spaces/313/product-team",
      "AuthorDisplayName": "Jane Doe",
      "AuthorEmail": "jane.doe@your-site.com",
      "AuthorFirstName": "Jane",
      "AuthorLastName": "Doe",
      "AuthorAvatarImageUrl": "https://your-site.com/Assets/Uploaded-Photos/630/avatar.jpg",
      "AuthorProfileUrl": "https://your-site.com/people/jane.doe",
      "TagsCSV": "",
      "DateCreatedString": "40 minutes ago",
      "DateCreatedShortString": "40 minutes ago",
      "DatePublishedString": "40 minutes ago",
      "DatePublishedShortString": "40 minutes ago",
      "DateUpdatedString": "8 minutes ago",
      "DateUpdatedShortString": "8 minutes ago",
      "ContentURL": "https://your-site.com/spaces/313/product-team/wiki/view/11943/onboarding-guide",
      "ContentVersionURL": "/spaces/313/product-team/wiki/view/11943/onboarding-guide/version/2?language=en-US",
      "IsPublishedFromDraftMode": false,
      "IsPublishedFromUnderProcessingMode": false,
      "IsBeingAddedViaExternalSource": false,
      "IsWallContent": false,
      "HasRead": false,
      "ContentTypeIconCSSClass": "icon-book",
      "IsEditable": true,
      "IsWOPI": false,
      "IsDeletable": true,
      "IsDownloadable": false,
      "IsCheckOutable": false,
      "IsChekoutable": false,
      "IsUndoCheckOutable": false,
      "IsUndochekoutable": false,
      "IsCheckinable": false,
      "IsChekinable": false,
      "IsRestorable": false,
      "IsRestoreable": false,
      "IsPurgeable": false,
      "IsHistoryViewable": true,
      "IsMoveable": false,
      "IsChildContentCreationAllowed": false,
      "IsContentCreationAllowed": false,
      "ContentMediaOnlineViewUrl": "",
      "ContentMediaUrl": "",
      "ContentHistoryUrl": "https://your-site.com/spaces/313/product-team/content/history/11943",
      "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=11943&vid=2','Google Docs',800,600)",
      "ViewerVote": 0,
      "VoteCount": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "TotalChildRecords": 0,
      "TotalGrandChildRecords": 0,
      "IsSticky": false,
      "IsAnswered": false,
      "AuthorRankImageUrl": "https://your-site.com/Assets/Uploaded-Photos/rank-guru.gif",
      "AuthorRankName": "Expert",
      "IsContentAvailablePostExpiry": false,
      "ContentIDCode": "f5am7VtP6VVGcgNxRezqCA%3D%3D",
      "SystemName": "",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 630,
      "DateCreatedISOString": "2026-09-26T20:15:27.7130000",
      "DateCreatedFullString": "Saturday, September 26, 2026 at 8:15 PM",
      "SendUpdateNotifications": false,
      "SendSMSTextNotification": false,
      "Culture": "en-US",
      "OriginalCulture": "en-US",
      "IsAvaiable": false,
      "ContentHistoryID": 0,
      "TenantID": 1
    }
  ]
}

Error Response

You do not have sufficient permissions to perform this action.

Error Handling

Status Code Likely Cause Next Action
400 Bad Request The endpoint does not return this status. Every parameter is optional, and a value of the wrong type is ignored rather than refused. Check the results rather than the status: a SpaceID the site cannot read is ignored and content from every space comes back.
401 Unauthorized A missing or invalid Bearer token answers 401 only on a site that allows members only; otherwise the call runs as a guest. Check token validity. Learn how to create Bearer tokens →
403 Forbidden The endpoint does not return this status. Content the caller cannot see is left out of the results. Confirm the user has the required roles for this action.
500 Server Error A number parameter (EntityType, EntityStatus, SortColumn, SortOrder, StartPage, or PageLength) carries a comma-separated value, SortColumn names a column this list cannot sort by, EntityTypeCSV or SpaceIDCsv is not a list of numbers, or DatePublishedTime is not a date. The response has no body. Check those parameters; the 500 is a rejected request, not a server fault.

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