KBCATPUBLIC: KB Category
Category for public-facing knowledge base articles. Used as a lookup from KBPUBLIC. Each category has a name, icon, colour, and sort order for display on the public portal.
Default definition. This article describes the default
KBCATPUBLIC definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches KBCATPUBLIC.Entity properties
| Property | Value |
|---|---|
| Entity code | KBCATPUBLIC |
| Display name | KB Category |
| Plural | KB Categories |
| Level | 52300 |
Use cases
KBCATPUBLIC provides dynamic categories for the public portal knowledge base. The portal rendering Lambda queries these records to build category navigation. The icon field stores a Font Awesome icon class and the color field stores a hex colour code for portal styling.
Fields
Category Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Category Name |
slug | text | Lowercase, hyphenated identifier used in the category URL. Generated automatically from the name when first saved. Editing this changes the URL. old links will break. | |
description | text (multi-line) | Description |
Portal Display
| Field | Type | Required | Notes |
|---|---|---|---|
icon | text (FA icon class) | Icon | |
color | text (hex colour) | Colour | |
sortOrder | number | Lower numbers appear first on the portal | |
active | boolean | Only active categories appear on the public portal |
Relationships
- No declared relationships in the default definition.
Creating a KB Category via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "KBCATPUBLIC",
"level": 52300,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"slug": "https://example.com",
"description": "Example text.",
"sortOrder": 1
}Listing KB Categories records
# All kb categories in your tenant
GET /v1/entities/KBCATPUBLIC/SUB