Loading ...

REST API: Get Tags | Communifire Documentation

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

REST API: Get Tags

0 
 /5
0 (0votes)

Get tags

GET /api/tags

Returns a list of tags based on the parameters specified in the URL. List of supported entities: Articles, Blogs, Wikis, Files, Videos, Ideas, Photos, Albums, Forum Topics, Forum Posts. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 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.
Optional Parameters How to use Description
SpaceID &spaceid=x - Used in the request URL (see below) Unique ID of the space from which the content is to be returned.
Don't pass any value to it if you want content from every space.
EntityType &entitytype=x - Used in the request URL (see below) The entity type of the content to be returned. Here are the values of Entity Type parameter:
  • Article = 3
  • Blog = 4
  • Photo = 6
  • Video = 7
  • Wiki = 9
  • File = 14
  • Album = 18
  • Idea = 44
  • ForumPost = 54
  • ForumTopic = 55
SearchText &searchtext=x - Used in the request URL (see below) The search keyword to return content for.
SortBy &sortby=x - Used in the request URL (see below) Sort content based on a value. Here are the values of Sort By parameter:
TagName = 1
Count = 2
SortOrder &sortorder=x - Used in the request URL (see below) The order in which content is to be sorted. Here are the values of Sort Order parameter:
Ascending = 0
Descending = 1
StartPage &startpage=x - Used in the request URL (see below) Specifies the starting page of list to be returned.
PageLength &pagelength=x - Used in the request URL (see below) Specifies the number of results to be returned per page.

Example URL to GET: https://your-community.com/api/tags?sortby=2&sortorder=1&pagelength=50

Response JSON sample where tag JSON object is returned as ResponseData

Here is an example of JSON data returned from the API call.

{
   "IsError": false,
   "ResponseMessage": "",
   "ResponseData": [
      {
      "TagID": 3,
      "TagName": "human-resources",
      "EntityID": 0,
      "EntityType": 0,
      "SpaceID": 0,
      "TagWeight": 0,
      "TagCount": 49,
      "TenantID": 1
      },
      {
      "TagID": 2,
      "TagName": "marketing",
      "EntityID": 0,
      "EntityType": 0,
      "SpaceID": 0,
      "TagWeight": 0,
      "TagCount": 33,
      "TenantID": 1
      },
      {
      "TagID": 12,
      "TagName": "sales",
      "EntityID": 0,
      "EntityType": 0,
      "SpaceID": 0,
      "TagWeight": 0,
      "TagCount": 31,
      "TenantID": 1
      },
      {
      "TagID": 14,
      "TagName": "announcement",
      "EntityID": 0,
      "EntityType": 0,
      "SpaceID": 0,
      "TagWeight": 0,
      "TagCount": 5,
      "TenantID": 1
      }
   ]
}

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

Wiki Index

Pages

Intranet Software