Loading ...

REST API: Get Content Category | Communifire Documentation

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

REST API: Get Content Category

0 
 /5
0 (0votes)

Get Content Category

GET /api/content/categories/{CategoryID}

Get a specific content category. 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.
CategoryID Used in the request URL as a path parameter Unique identifier for a particular content category. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas.

Example Request

GET https://myintranet.communifire.com/api/content/categories/1695

Example Response

Content category JSON object is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
    {
        "CategoryID":1695,
        "EntityType":4,
        "SpaceID":0,
        "CategoryName”:”stars”,
        "SpaceName":null,
        "CategoryDescription”:”A fixed luminous point in the night sky which is a large, remote incandescent body like the sun..",
        "ParentCategoryID":0,
        "CategoryStub”:”stars”,
        "StatusID":0,
        "ParentCategoryName":null,
        "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