Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference
Help Center

Help Centers

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

List help centers
GET/v2/help_center/help_centers
Get a help center by ID
GET/v2/help_center/help_centers/{id}
ModelsExpand Collapse
HelpCenter object { id, availableLocales, createdAt, 17 more }
id: string

Help center unique identifier

availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more

Available locales

One of the following:
"bn"
"bs"
"pt-BR"
"bg"
"ca"
"hr"
"cs"
"da"
"nl"
"en"
"et"
"fi"
"fr"
"de"
"el"
"hi"
"hu"
"id"
"it"
"ja"
"ko"
"lv"
"lt"
"ms"
"mn"
"nb"
"pl"
"pt"
"ro"
"ru"
"sr"
"zh-CN"
"sk"
"sl"
"es"
"sw"
"sv"
"th"
"zh-TW"
"tr"
"uk"
"vi"
createdAt: string

ISO 8601 timestamp when created

defaultLocale: "bn" or "bs" or "pt-BR" or 39 more

Default locale for the help center

One of the following:
"bn"
"bs"
"pt-BR"
"bg"
"ca"
"hr"
"cs"
"da"
"nl"
"en"
"et"
"fi"
"fr"
"de"
"el"
"hi"
"hu"
"id"
"it"
"ja"
"ko"
"lv"
"lt"
"ms"
"mn"
"nb"
"pl"
"pt"
"ro"
"ru"
"sr"
"zh-CN"
"sk"
"sl"
"es"
"sw"
"sv"
"th"
"zh-TW"
"tr"
"uk"
"vi"
isPublic: boolean

Whether the help center is public

locale: "bn" or "bs" or "pt-BR" or 39 more

Current locale

One of the following:
"bn"
"bs"
"pt-BR"
"bg"
"ca"
"hr"
"cs"
"da"
"nl"
"en"
"et"
"fi"
"fr"
"de"
"el"
"hi"
"hu"
"id"
"it"
"ja"
"ko"
"lv"
"lt"
"ms"
"mn"
"nb"
"pl"
"pt"
"ro"
"ru"
"sr"
"zh-CN"
"sk"
"sl"
"es"
"sw"
"sv"
"th"
"zh-TW"
"tr"
"uk"
"vi"
object: "help_center"

Object type identifier

organization: string

Organization ID

updatedAt: string

ISO 8601 timestamp when last updated

description: optional string

Help center description

displayName: optional string

Help center display name

externalLinksOpenInNewTab: optional boolean

Whether external links in articles open in a new tab

hideAuthorInfo: optional boolean

Whether to hide author info on articles

hideDateInfo: optional boolean

Whether to hide date info on articles

internalLinksOpenInNewTab: optional boolean

Whether internal links in articles open in a new tab

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search input placeholder

title: optional string

Help center title

translations: optional object { id, bg, bn, 39 more }

Translations for different locales

id: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

bg: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

bn: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

bs: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

ca: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

cs: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

da: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

de: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

el: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

en: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

es: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

et: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

fi: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

fr: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

hi: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

hr: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

hu: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

it: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

ja: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

ko: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

lt: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

lv: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

mn: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

ms: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

nb: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

nl: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

pl: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

pt: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

"pt-BR": optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

ro: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

ru: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

sk: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

sl: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

sr: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

sv: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

sw: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

th: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

tr: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

uk: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

vi: optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

"zh-CN": optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

"zh-TW": optional HelpCenterTranslation { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale

urls: optional object { externalDomain, featurebaseSubpath }

URLs configuration

externalDomain: optional string

External custom domain

featurebaseSubpath: optional string

Featurebase subpath

HelpCenterNavItem object { title, type, url, icon }
title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

HelpCenterTranslation object { description, displayName, navItems, 2 more }
description: optional string

Description for this locale

displayName: optional string

Display name for this locale

title: string

Navigation item title

type: "link" or "button"

Navigation item type

One of the following:
"link"
"button"
url: string

Navigation item URL

icon: optional string

Navigation item icon

searchPlaceholder: optional string

Search placeholder for this locale

title: optional string

Title for this locale