Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference

Help Center

Help CenterHelp 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

Help CenterCollections

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

List collections
GET/v2/help_center/collections
Create a collection
POST/v2/help_center/collections
Get a collection by ID
GET/v2/help_center/collections/{id}
Update a collection
PATCH/v2/help_center/collections/{id}
Delete a collection
DELETE/v2/help_center/collections/{id}
ModelsExpand Collapse
Collection object { id, availableLocales, createdAt, 19 more }
id: string

Collection 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

helpCenterId: string

Help center ID

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: "collection"

Object type identifier

organization: string

Organization ID

parentId: string

Parent collection ID

updatedAt: string

ISO 8601 timestamp when last updated

articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

collapseSidebar: optional boolean

Whether to collapse sidebar

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

Default 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"
description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

icon: optional object { type, value }

Collection icon

type: string

Icon type

value: string

Icon value

name: optional string

Collection name

order: optional number

Display order

path: optional string

Collection path

slug: optional string

URL slug

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

Translations by locale code

id: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

bg: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

bn: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

bs: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

ca: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

cs: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

da: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

de: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

el: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

en: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

es: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

et: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

fi: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

fr: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

hi: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

hr: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

hu: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

it: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

ja: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

ko: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

lt: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

lv: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

mn: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

ms: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

nb: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

nl: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

pl: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

pt: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

"pt-BR": optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

ro: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

ru: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

sk: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

sl: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

sr: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

sv: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

sw: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

th: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

tr: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

uk: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

vi: optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

"zh-CN": optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

"zh-TW": optional CollectionTranslation { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

CollectionIconNova object { type, value }

An updated icon object for the collection

type: "emoji" or "predefined"

Icon type (e.g., “emoji”)

One of the following:
"emoji"
"predefined"
value: string

Icon value

maxLength255
CollectionTranslation object { articleCount, authorCount, authors, 5 more }
articleCount: optional number

Number of articles

authorCount: optional number

Number of authors

authors: optional array of object { authorId, avatarUrl, name }

List of authors

authorId: optional string

Author ID

avatarUrl: optional string

Author avatar URL

name: optional string

Author name

description: optional string

Collection description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

name: optional string

Collection name

slug: optional string

URL slug

CollectionTranslationInputNova object { description, name }
description: optional string

Collection description in this locale

maxLength512
name: optional string

Collection name in this locale

maxLength255
CollectionDeleteResponse object { id, deleted, object }
id: string

Unique identifier of the deleted collection

deleted: true

Indicates the resource was deleted

object: "collection"

Object type identifier

Help CenterArticles

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

List articles
GET/v2/help_center/articles
Create an article
POST/v2/help_center/articles
Get an article by ID
GET/v2/help_center/articles/{id}
Update an article
PATCH/v2/help_center/articles/{id}
Delete an article
DELETE/v2/help_center/articles/{id}
ModelsExpand Collapse
Article object { id, availableLocales, createdAt, 27 more }
id: string

Article 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

helpCenterId: string

Help Center ID

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: "article"

Object type identifier

organization: string

Organization ID

state: "live" or "draft"

Article state

One of the following:
"live"
"draft"
updatedAt: string

ISO 8601 timestamp when last updated

author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

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

Default 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"
description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

icon: optional object { type, value }

Article icon

type: "emoji" or "custom"

Icon type

One of the following:
"emoji"
"custom"
value: string

Icon value (emoji or URL)

isDraftDiffersFromLive: optional boolean

Whether draft differs from live

isPublished: optional boolean

Whether the article is published

liveUpdatedAt: optional string

ISO 8601 timestamp when live version was last updated

order: optional number

Display order

parentId: optional string

Parent collection ID

path: optional string

Path to article within help center hierarchy

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

Published 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"
slug: optional string

URL slug

surveyId: optional string

Associated survey ID

title: optional string

Article title

translationCreatedAt: optional string

ISO 8601 timestamp when translation was created

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

Translations by locale code

id: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

bg: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

bn: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

bs: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

ca: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

cs: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

da: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

de: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

el: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

en: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

es: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

et: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

fi: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

fr: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

hi: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

hr: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

hu: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

it: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

ja: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

ko: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

lt: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

lv: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

mn: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

ms: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

nb: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

nl: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

pl: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

pt: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

"pt-BR": optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

ro: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

ru: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

sk: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

sl: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

sr: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

sv: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

sw: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

th: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

tr: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

uk: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

vi: optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

"zh-CN": optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

"zh-TW": optional ArticleTranslation { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

translationUpdatedAt: optional string

ISO 8601 timestamp when translation was last updated

visibleBy: optional array of string

Visibility settings

ArticleAuthor object { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

ArticleIconInputNova object { type, value }

Icon object for the article

type: "emoji" or "predefined"

Type of icon (emoji or predefined only)

One of the following:
"emoji"
"predefined"
value: string

Icon value

maxLength255
ArticleTranslation object { author, body, createdAt, 6 more }
author: optional ArticleAuthor { authorId, name, avatarUrl }

Article author

authorId: string

Author user ID

name: string

Author name

avatarUrl: optional string

Author avatar URL

body: optional string

Article body content (HTML)

createdAt: optional string

ISO 8601 timestamp when translation was created

description: optional string

Article description

externalUrl: optional string

External URL

featurebaseUrl: optional string

Featurebase URL

slug: optional string

URL slug

title: optional string

Article title

updatedAt: optional string

ISO 8601 timestamp when translation was last updated

ArticleTranslationInputNova object { body, description, title }
body: optional string

Article body content in this locale (HTML or markdown)

description: optional string

Article description in this locale

maxLength512
title: optional string

Article title in this locale

maxLength512
ArticleDeleteResponse object { id, deleted, object }
id: string

Unique identifier of the deleted article

deleted: true

Indicates the resource was deleted

object: "article"

Object type identifier

Help CenterRedirect Rules

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

List redirect rules
GET/v2/help_center/redirect_rules
Create a redirect rule
POST/v2/help_center/redirect_rules
Get a redirect rule by URL
GET/v2/help_center/redirect_rules/by-url
Get a redirect rule by ID
GET/v2/help_center/redirect_rules/{id}
Update a redirect rule
PATCH/v2/help_center/redirect_rules/{id}
Delete a redirect rule
DELETE/v2/help_center/redirect_rules/{id}
ModelsExpand Collapse
RedirectRule object { id, createdAt, fromUrl, 6 more }
id: string

Redirect rule unique identifier

createdAt: string

ISO 8601 timestamp when created

fromUrl: string

Canonical source URL being redirected from (query and hash stripped)

helpCenterId: string

Help center identifier

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

Locale code for the redirect rule

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: "redirect_rule"

Object type identifier

targetId: string

Target article or collection ID

targetType: "article" or "collection"

Type of content the redirect points to

One of the following:
"article"
"collection"
updatedAt: string

ISO 8601 timestamp when last updated

RedirectRuleDeleteResponse object { id, deleted, object }
id: string

Unique identifier of the deleted redirect rule

deleted: true

Indicates the resource was deleted

object: "redirect_rule"

Object type identifier