Knowledge bases allow you to create documentation sites that can be internal to your company or available publicly to your customers. Your company can have multiple knowledge bases. To learn about knowledge bases, refer to our Help Center.
Knowledge base endpoints only support API tokens
At this time, you cannot access the knowledge base endpoint using OAuth. You must access them with an API token that has a scope set to
Knowledge Base
.
Access knowledge base content through a simple, unauthenticated JSON output
If you publish your knowledge base to a public domain, we offer a public API that returns your articles, categories, resource links, and sections without requiring authentication. This API is simpler to access than the endpoints described in this section, but if you need the data to be returned in a more structured format or to update or delete knowledge base resources, then you can only do so through the authenticated knowledge base endpoints described herein.
Categories and articles
Knowledge bases are composed of categories and articles. The articles are the help topics that users read, and they are organized in categories. Articles can only belong to one category.
Locales
Knowledge bases support multiple locales so you can supply content in multiple languages. The following is the list of the supported locales.
Language | Locale Code |
---|---|
Bosnian | bs |
Bulgarian | bq |
Catalan | ca |
Chinese simplified | zh-CN |
Chinese traditional | zh-TW |
Croatian | hr |
Czech | cs |
Danish | da |
Dutch | nl |
English | en |
Estonian | et |
Finnish | fi |
French | fr |
German | de |
Greek | el |
Hungarian | hu |
Icelandic | is |
Indonesian | id |
Italian | it |
Japanese | ja |
Korean | ko |
Latvian | lv |
Lithuanian | lt |
Malay | ms |
Norwegian | no |
Polish | pl |
Portuguese Brazil | pt-BR |
Portuguese Portugal | pt-PT |
Romanian | ro |
Russian | ru |
Serbian | sr |
Slovak | sk |
Slovenian | sl |
Spanish | es |
Swedish | sv |
Turkish | tr |
Ukrainian | uk |
Vietnamese | vi |