KB Article Schema
Felder
KB Article Schema
Knowledge base article
articleNumber
Human-readable article number (server-generated, e.g. K-2026-00042)
title
Article title
slug
URL-friendly slug (auto-generated from title if missing)
content
Article body (plain text or Markdown depending on bodyFormat)
contentHtml
Rich-text HTML body (sanitized server-side)
bodyFormat
Content format used for rendering
MARKDOWNHTMLBLOCKScategory
Category label (free-text)
categoryId
Optional structured category UUID
status
Workflow status
DRAFTREVIEWPUBLISHEDARCHIVEDisPublished
Publication flag (mirrors status === PUBLISHED)
viewCount
Number of times the article has been viewed
authorId
Primary author user UUID (protected — assigned server-side)
successorAuthorId
Designated successor when the current author is offboarded
isPortalVisible
Visible in the customer portal
visibleToPartyIds
When non-empty, restricts portal visibility to these parties
tags
Free-text tags
attachments
linkedEntities
embeddingStatus
PENDINGPROCESSINGDONEFAILEDlastEmbeddedAt
spaceId
Owning kb_space UUID. Articles without a space appear in the default space.
parentId
Parent article UUID for hierarchy
sortOrder
Sort order among siblings under parentId
path
Materialized ancestor path (denormalized)
rootArticleId
Denormalized root article UUID for share-based visibility
isTemplate
If true, this article acts as a template/blueprint
templateName
templateDescription
icon
Emoji grapheme (e.g. "🚀") OR an Icons key from the shared set (e.g. "Server"). Rendered as an icon when the value matches an Icons key, otherwise as text.
iconColor
Optional accent color for the article icon (hex, e.g. "#3b82f6")
nextReviewDate
Scheduled date for the next content review
lastReviewedAt
Timestamp of the last completed review
Keine Felder passen zum Filter.
Standard-Endpoints
Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:
GET /api/v1/kb_articles— Liste, paginiert + filterbarGET /api/v1/kb_articles/<id>— Einzelne EntityPOST /api/v1/kb_articles— AnlegenPATCH /api/v1/kb_articles/<id>— Teil-UpdateDELETE /api/v1/kb_articles/<id>— Soft-DeleteGET /api/v1/kb_articles/<id>/timeline— Audit + Aktivitäten