Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference
Help Center

Collections

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