Knowledge base API

Articles

An article is one help page in your knowledge base, such as "How to return an order". Each article keeps its own versions for each language, and customers and agents only see the published version in each language.

getGet Articles/v1/kb/articlespostCreate an Article/v1/kb/articlesgetGet Article by ID/v1/kb/articles/{id}putUpdate Article/v1/kb/articles/{id}getSearch Articles/v1/kb/articles/search

Articles (Public)

An article is one help page in your knowledge base, such as "How to return an order". Each article keeps its own versions for each language, and customers and agents only see the published version in each language.

getGet Articles (Public)/p/v3/kb/articlesgetSearch Articles (Public)/p/v3/kb/articles/search

Articles (Schedules)

An article is one help page in your knowledge base, such as "How to return an order". Each article keeps its own versions for each language, and customers and agents only see the published version in each language.

postCreate article schedule/v1/kb/articles/{id}/schedulesputUpdate Article Schedule/v1/kb/articles/{id}/schedules/{type}/{lang}DELDelete Article Schedule/v1/kb/articles/{id}/schedules/{type}/{lang}

Articles (Versioning and Languages)

An article is one help page in your knowledge base, such as "How to return an order". Each article keeps its own versions for each language, and customers and agents only see the published version in each language.

getGet Article Versions by Language/v1/kb/articles/{id}/versions/{lang}postCreate a Version/v1/kb/articles/{id}/versions/{lang}DELDelete Versions of a Language/v1/kb/articles/{id}/versions/{lang}putUpdate a Draft Version/v1/kb/articles/{id}/versions/{lang}/draftDELDelete a Draft Version/v1/kb/articles/{id}/versions/{lang}/draftputUpdate Latest Published Article Version/v1/kb/articles/{id}/versions/{lang}/latestgetGet Article Version by ID/v1/kb/versions/{id}

Categories (Internal)

Categories are the folders that organize a knowledge base's articles into a tree you can browse, such as "Orders" containing "Returns". Each knowledge base has its own tree, and the help center builds its navigation from it.

getGet Internal Categories/v1/kb/internal/categoriespostCreate an Internal Category/v1/kb/internal/categoriesgetGet Internal Category by ID/v1/kb/internal/categories/{id}

Categories (Public)

Categories are the folders that organize a knowledge base's articles into a tree you can browse, such as "Orders" containing "Returns". Each knowledge base has its own tree, and the help center builds its navigation from it.

getGet Categories (Public)/p/v3/kb/categoriesgetGet Category by ID (Public)/p/v3/kb/categories/{id}

Forms

A form is a contact form on your help center, such as "Contact support" or "Report a problem". When a customer submits it, Kustomer opens a conversation with their answers, or hands the submission to a form hook for a workflow to process.

getGet Forms/v1/kb/formspostCreate a Form/v1/kb/formsgetGet Form by ID/v1/kb/forms/{id}putUpdate Form/v1/kb/forms/{id}DELDelete Form/v1/kb/forms/{id}getGet Form by ID (Public)/p/v3/kb/forms/{id}

Knowledge Bases

A knowledge base is one help center site, with its own address, languages, theme and brand. Every org has a default knowledge base, and an org with several brands can add one knowledge base per brand.

postCreate Knowledge Base/v1/kb/knowledge-basesgetGet Knowledge Base by ID/v1/kb/knowledge-bases/{id}patchUpdate Knowledge Base/v1/kb/knowledge-bases/{id}

Tags (Knowledge Base)

Knowledge base tags are labels you attach to articles, such as "billing" or "mobile app", to group related articles across categories. They are separate from the tags used on conversations.

getGet tags/v3/kb/tagspostCreate tag/v3/kb/tagsgetGet Tags by ID/v3/kb/tags/{id}patchUpdate Tag by ID./v3/kb/tags/{id}

Themes

A theme controls how a help center looks and is laid out, from colors and fonts to the code for each page. Themes keep a history of revisions, so you can edit and preview a draft before you publish it. Templates are the ready-made starting points that new themes are copied from.

getGet Themes/v3/kb/themespostCreate a Theme/v3/kb/themesgetGet Themes by ID/v3/kb/themes/{id}getGet Active Theme (Public)/p/v3/kb/themes/activegetGet Theme by ID (Public)/p/v3/kb/themes/{id}

Themes (Drafts and Revisions)

A theme controls how a help center looks and is laid out, from colors and fonts to the code for each page. Themes keep a history of revisions, so you can edit and preview a draft before you publish it. Templates are the ready-made starting points that new themes are copied from.

getGet Theme Revisions/v3/kb/themes/{themeId}/revisionsgetGet Theme Revision by ID/v3/kb/themes/{themeId}/revisions/{id}postCreate Theme Draft Revision/v3/kb/themes/{themeId}/revisions/draftputUpdate Theme Draft Revision/v3/kb/themes/{themeId}/revisions/draftDELDelete Theme Draft Revision/v3/kb/themes/{themeId}/revisions/draft

Themes (Theme Files)

A theme controls how a help center looks and is laid out, from colors and fonts to the code for each page. Themes keep a history of revisions, so you can edit and preview a draft before you publish it. Templates are the ready-made starting points that new themes are copied from.

getGet Theme Files by Revision/v3/kb/themes/{themeId}/revisions/{revisionId}/filespostCreate Revision Theme File/v3/kb/themes/{themeId}/revisions/{revisionId}/filesgetGet Theme Files (Public)/p/v3/kb/themes/{id}/filesgetGet Theme File by Revision/v3/kb/themes/{themeId}/revisions/{revisionId}/files/{id}putUpdate Revision Theme File/v3/kb/themes/{themeId}/revisions/{revisionId}/files/{id}DELDelete Revision Theme File/v3/kb/themes/{themeId}/revisions/{revisionId}/files/{id}

Templates

A theme controls how a help center looks and is laid out, from colors and fonts to the code for each page. Themes keep a history of revisions, so you can edit and preview a draft before you publish it. Templates are the ready-made starting points that new themes are copied from.

getGet Templates/v3/kb/templatesgetGet Templates by ID/v3/kb/templates/{id}

Routes

A route maps a URL path on your help center to an article or category, so old and custom links keep working. When a visitor opens a path that matches a route, the help center redirects them to the content's current address.

getGet Route by URL (Public)/v1/kb/routegetGet Routes/v1/kb/routespostCreate a Route/v1/kb/routesgetGet Routes by Article ID/v1/kb/articles/{id}/routesgetGet Routes by Category ID/v1/kb/categories/{id}/routespostCreate a Category Route/v1/kb/categories/{id}/routesgetGet Route by ID/v1/kb/routes/{id}putUpdate Route/v1/kb/routes/{id}DELDelete Route by ID/v1/kb/routes/{id}

Knowledge Bases (Custom Domains)

A knowledge base is one help center site, with its own address, languages, theme and brand. Every org has a default knowledge base, and an org with several brands can add one knowledge base per brand.

getGet Custom Domain By ID/v1/kb/knowledge-bases/{id}/domains/{domainId}getGet Custom Domains/v1/kb/knowledge-bases/{id}/domainsputUpdate Custom Domain/v1/kb/knowledge-bases/{id}/domain/{domainId}DELDelete Custom Domain/v1/kb/knowledge-bases/{id}/domain/{domainId}postCreate Custom Domain/v1/kb/knowledge-bases/{id}/domain