Knowledge Base Category Resource

A knowledge base category is a category created in the context of the knowledge base.

Knowledge Base SubCategory Resource

A knowledge base subcategory is a subcategory created in the context of the knowledge base. The subcategory is optional and belongs to a category.

Changelog

2025.0.0

Added audienceType property to the category. The value can be 'network' or 'group'.
Added numAudience property to our knowledge base categories.
Added numArticles property to our knowledge base categories.
Added numSubArticles property to our knowledge base categories.
Added numSubcategories property to our knowledge base categories.

Endpoints

Representations

JSON Properties

Name	Type	Description
EID	EID	Unique entity identifier
parentKnowledgeBaseCategoryEID	EID	Unique entity identifier of the parent category, if applicable.
title	string	The title of the category
description	string	The description of the category
iconType	string	The type of the icon of the category
iconColor	string	The hexadecimal value of the icon color.
coverImageUrl	string	The url of the cover image.
audienceType	string	The Type of the audience. Could be group or network.
numAudience	int	The number of audience. In case of network, it's always 1.
numArticles	int	The number of articles that belongs to this category.
numSubArticles	int	The number of sub-articles that belongs to this category.
numSubCategories	int	The number of sub-categories that belongs to this category.

Links

Relation	Resource	Description
groups	group	Groups

Example (category)

{
    "_links": {
        "groups": {
            "href": "/networks/0000000000000001/groups/?eid=1234567890ABCDEF"
        },
        "self": {
            "href": "/networks/0000000000000001/knowledge-base/categories/1234567890FEDCAB/"
        }
    },
    "_embedded": {
        "groups": []
    },
    "EID": "1234567890FEDCAB",
    "title": "KB Category",
    "description": "Category description",
    "iconType": "book",
    "iconColor": "#ff0000",
    "coverImageUrl": "https://static.dev.speakap.nl/img/covers/default-category-cover.jpeg",
    "audienceType": "network",
    "numAudiences": 1,
    "numArticles": 0,
    "numSubArticles": 0,
    "numSubcategories": 0
}