Loading ...

REST API: Get Tag Groups | Communifire Documentation

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

REST API: Get Tag Groups

0 
 /5
0 (0votes)

Get tag groups

GET /api/taggroups/list

Get a list of tag groups. 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
FetchTags &fetchTags=x - Used in the request URL (see below) Whether tags should be included in result. Set true/false.

Example URL to GET: https://your-community.com/api/taggroups/list?fetchTags=true

Response JSON sample where tag group JSON object is returned as ResponseData


{
 "TagGroupID": 21,
 "TagGroupName": "Departments",
 "Tags": [
   {
     "TagID": 608,
     "TagGroupID": 21,
     "TagName": "information-technology",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 32,
     "TenantID": 1
   },
   {
     "TagID": 609,
     "TagGroupID": 21,
     "TagName": "marketing",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 45,
     "TenantID": 1
   },
   {
     "TagID": 610,
     "TagGroupID": 21,
     "TagName": "sales",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 92,
     "TenantID": 1
   },
   {
     "TagID": 611,
     "TagGroupID": 21,
     "TagName": "human-resources",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 111,
     "TenantID": 1
   },
   {
     "TagID": 612,
     "TagGroupID": 21,
     "TagName": "operations",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 37,
     "TenantID": 1
   },
   {
     "TagID": 613,
     "TagGroupID": 21,
     "TagName": "purchasing",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 28,
     "TenantID": 1
   },
   {
     "TagID": 614,
     "TagGroupID": 21,
     "TagName": "research-and-development",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 47,
     "TenantID": 1
   },
   {
     "TagID": 615,
     "TagGroupID": 21,
     "TagName": "finance",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 61,
     "TenantID": 1
   }
 ],
 "TenantID": 1
},
{
 "TagGroupID": 20,
 "TagGroupName": "Offices",
 "Tags": [
   {
     "TagID": 601,
     "TagGroupID": 20,
     "TagName": "san-diego",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 48,
     "TenantID": 1
   },
   {
     "TagID": 602,
     "TagGroupID": 20,
     "TagName": "san-francisco",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 48,
     "TenantID": 1
   },
   {
     "TagID": 603,
     "TagGroupID": 20,
     "TagName": "los-angeles",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 91,
     "TenantID": 1
   },
   {
     "TagID": 604,
     "TagGroupID": 20,
     "TagName": "new-york",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 85,
     "TenantID": 1
   },
   {
     "TagID": 605,
     "TagGroupID": 20,
     "TagName": "allentown",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 19,
     "TenantID": 1
   },
   {
     "TagID": 606,
     "TagGroupID": 20,
     "TagName": "miami",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 39,
     "TenantID": 1
   },
   {
     "TagID": 607,
     "TagGroupID": 20,
     "TagName": "london",
     "EntityID": 0,
     "EntityType": 0,
     "SpaceID": 0,
     "TagWeight": 0,
     "TagCount": 59,
     "TenantID": 1
   }
 ],
 "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