Loading ...

REST API: Get Content Categories | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Content Category » REST API: Get Content Categories
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 23

REST API: Get Content Categories

0 
 /5
0 (0votes)

Get Content Categories

GET /api/content/categories

Get a list of content categories. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&Token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
EntityTypeID &EntityTypeID=x - Used in the request URL as a query parameter The entity type of the content category to be returned. Here are the values of EntityType parameter:
  • Article = 3
  • Blog = 4
  • Video = 7
  • CMS Page = 12
  • Idea = 44
Optional Parameters How to use Description
SpaceID &SpaceID=x - Used in the request URL as a query parameter ID of the space from which the content category is to be returned.
ParentCategoryID &ParentCategoryID=x - Used in the request URL as a query parameter ID of the parent category to return categories for.

Example Request

GET https://myintranet.communifire.com/api/content/categories?EntityTypeID=3&SpaceID=179

Example Response

Content category JSON object is returned as ResponseData.

{
   "IsError":false,
   "ResponseMessage":"",
   "ResponseData":
   [
      {
         "CategoryID":1299,
         "EntityType":3,
         "SpaceID":179,
         "CategoryName":"News",
         "SpaceName":null,
         "CategoryDescription":"News",
         "ParentCategoryID":0,
         "CategoryStub":"news",
         "StatusID":1,
         "ParentCategoryName":"N/A",
         "ContentCount":0,
         "CategoryCount":0
      },
      {
         "CategoryID":1298,
         "EntityType":3,
         "SpaceID":179,
         "CategoryName":"Press Release",
         "SpaceName":null,
         "CategoryDescription":"Press Release",
         "ParentCategoryID":0,
         "CategoryStub":"press-release",
         "StatusID":1,
         "ParentCategoryName":"N/A",
         "ContentCount":0,
         "CategoryCount":0
      }
   ]
}

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software