Skip to main content

​
Fields

​
object
string
required
Always "knowledge_base".
​
id
uuid
required
Server-generated identifier.
​
name
string
required
Display name shown in the dashboard and on the public KB site.
​
slug
string
required
Internal handle. Unique per org. Used in dashboard URLs.
​
public_slug
string
required
Short opaque handle used to build the public URL: https://kb.awardee.dev/{public_slug}. Stable for the KB’s lifetime.
​
description
string | null
Optional one-liner shown on the public landing page.
​
logo_url
string | null
Absolute URL of the KB’s logo image.
​
primary_color
string | null
Hex color (#RRGGBB) used as the accent on the public KB site.
​
is_published
boolean
required
When true, the KB is reachable at its public_slug. When false, the public URL 404s.
​
created_at
datetime
required
ISO-8601 timestamp of insertion.
​
updated_at
datetime
required
ISO-8601 timestamp of the most recent edit.

​
Example

{
  "object": "knowledge_base",
  "id": "2c1b4a9f-7e8d-4a3c-9b1f-6e5d4c3b2a1f",
  "name": "Help Center",
  "slug": "help-center",
  "public_slug": "k7Hq3M2",
  "description": "Everything our customers need to know about returns, shipping, and account management.",
  "logo_url": "https://cdn.example.com/logo.png",
  "primary_color": "#007495",
  "is_published": true,
  "created_at": "2026-05-01T08:00:00Z",
  "updated_at": "2026-05-23T09:58:21Z"
}