Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference
Help Center

Articles

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