-
article_idstring Required -
account_idstring Required -
user_idstring Required -
category_idstring Required -
titlestring Required -
descriptionstring Required -
short_versionstring Required -
bodystring Required -
slugstring Required -
iconstring Required -
tagsarray of string Required Nullable -
show_tocboolean Required -
is_privateboolean Required -
is_publishedboolean Required -
is_archivedboolean Required -
statusstring Required -
archived_atstring (date-time) Nullable -
archived_bystring -
archive_reasonstring -
is_featuredboolean Required -
related_article_idsarray of string Required Nullable -
related_autoboolean Required -
is_current_versionboolean Required -
version_numberinteger Required -
sourcestring Required -
external_idstring -
editor_typestring Required -
created_atstring (date-time) Required Nullable -
updated_atstring (date-time) Required Nullable -
permission_groupsarray of string Required Nullable -
urlstring Required -
relative_urlstring Required -
description_was_autogeneratedboolean Required -
short_version_was_autogeneratedboolean Required
HelpDocs API
The HelpDocs REST API.
Authenticate with an API key sent as a bearer token (Authorization: Bearer <key>). Keys carry read or write permission; each operation states which it needs. An app acting for a HelpDocs user can instead send an OAuth 2.0 access token the same way, holding the scope each operation names.
Servers
-
https://api.helpdocs.io
Authentication
-
-
ApiKeyBearerhttpbearerAn API key sent as
Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.
-
Analytics
Readership figures for the account’s articles.
Articles
The documents in a knowledge base. An article belongs to one category and may carry a translation per language the account has enabled.
-
GET
/v1/articleList articles -
POST
/v1/articleCreate an article -
GET
/v1/article/countCount articles -
POST
/v1/article/count/batchCount articles for several filter sets at once -
GET
/v1/article/existsCheck whether an article already exists -
GET
/v1/article/tagsList every tag in use -
GET
/v1/article/{article_id}Retrieve an article -
PATCH
/v1/article/{article_id}Update an article -
DELETE
/v1/article/{article_id}Delete an article -
GET
/v1/article/{article_id}/diff/{version_1_number}/{version_2_number}Compare two versions of an article -
POST
/v1/article/{article_id}/imageUpload an image to an article -
POST
/v1/article/{article_id}/publishPublish an article's working copy -
POST
/v1/article/{article_id}/restoreRestore a deleted article -
GET
/v1/article/{article_id}/versionsList an article's versions -
DELETE
/v1/article/{article_id}/working-copyDiscard an article's working copy
Categories
The hierarchy articles are organised into.
Clips
Reusable content fragments that articles embed, so shared copy is written once.
Languages
The languages an account’s articles and categories are translated into.
Permission Groups
Groups that control which readers may see which articles. An article carries the groups allowed to read it.
Search
Full-text search across the account’s published articles.
Variables
Short reusable values, such as a product name, that articles and clips reference and that are filled in when an article is rendered.
Schemas
AccountUserGroup
object
-
group_idstring Required -
namestring Required -
created_atstring (date-time) Required Nullable
AggregateFeedback
object
-
positiveinteger Required -
neutralinteger Required -
negativeinteger Required -
totalinteger Required -
happinessinteger Required
AnalyticsFeedbackResponse
object
ArticleFeedback
object
-
article_idstring Required -
titlestring Required
AnalyticsGraphResponse
object
AnalyticsPoint
object
-
date_stringstring -
datenumber -
article_idstring -
category_idstring -
user_idstring -
user_agent_browserstring -
user_agent_osstring -
ip_rangestring -
countinteger Required -
sessionsinteger
Article
object
ArticleAuthor
object
-
namestring Required -
emailstring -
profile_imagestring Required
ArticleStaleStatus
object
-
is_staleboolean Required -
reasonstring Required -
sourcestring Required -
triggered_atstring (date-time) Required Nullable -
expires_atstring (date-time) Required Nullable
ArticleLanguage
object
-
language_codestring Required -
titlestring Required -
descriptionstring Required -
short_versionstring Required -
bodystring Required -
slugstring Required -
tagsarray of string Required Nullable -
user_idstring Required -
urlstring Required -
relative_urlstring Required -
is_liveboolean Required -
is_current_versionboolean Required -
version_numberinteger Required -
editor_typestring Required -
machine_translated_atstring (date-time) Nullable -
has_working_copyboolean Nullable -
created_atstring (date-time) Required -
content_tokenstring
ArticleCountBatchResponse
object
BatchCountResult
object
-
idstring -
countinteger Required -
errorstring
ArticleCountFilter
object
-
idstring -
article_idarray of string NullableNull is the same as leaving the field out.
-
category_idarray of string NullableNull is the same as leaving the field out.
-
tagarray of string NullableNull is the same as leaving the field out.
-
combine_tagsstring -
permission_grouparray of string NullableNull is the same as leaving the field out.
-
combine_permission_groupsstring -
statusarray of string NullableNull is the same as leaving the field out.
-
user_idarray of string NullableNull is the same as leaving the field out.
-
working_copy_user_idarray of string NullableNull is the same as leaving the field out.
-
search_termstring -
is_staleboolean NullableNull is the same as leaving the field out.
-
needs_translationboolean NullableNull is the same as leaving the field out.
-
outdated_translationboolean NullableNull is the same as leaving the field out.
-
has_working_copyboolean NullableNull is the same as leaving the field out.
-
language_codestring -
updated_at_beforestring -
updated_at_afterstring -
combine_filtersstring -
working_copyboolean -
only_deletedboolean -
include_archivedboolean
ArticleDiffResponse
object
-
diffstring Required -
language_codestring Required -
from_version_numberinteger Required -
to_version_numberinteger Required -
left_version_numberinteger Required -
right_version_numberinteger Required -
generated_atstring (date-time) Required
DiffRow
object
-
statusstring Required -
leftstring Required -
rightstring Required
ArticleExistsResponse
object
-
existsboolean Required -
article_idstring Required
FeedbackCounts
object
-
positiveinteger Required -
neutralinteger Required -
negativeinteger Required -
totalinteger Required
ArticleResponse
object
ArticleTagCount
object
-
tagstring Required -
countinteger Required
ArticleVersion
object
-
languagestring Required -
version_numberinteger Required -
is_current_versionboolean Required -
kindstring -
originstring -
origin_clientstring -
user_idstring Required -
bodystring Required -
created_atstring (date-time) Required Nullable
ArticleVersionsResponse
object
-
totalinteger Required -
has_moreboolean Required -
next_beforeinteger
ArticlesResponse
object
BatchCountRequest
object
-
Null is the same as leaving the field out.
CategoriesResponse
object
Category
object
-
category_idstring Required -
account_idstring Required -
parent_category_idstring Required -
titlestring Required -
descriptionstring Required -
slugstring Required -
is_featuredboolean Required -
iconstring Required -
external_idstring -
created_atstring (date-time) Required Nullable -
updated_atstring (date-time) Required Nullable -
permission_groupsarray of string Required Nullable -
enforce_permissionsboolean Required -
urlstring Required -
relative_urlstring Required -
live_article_countinteger Nullable -
archived_article_countinteger Nullable -
name_onlyboolean
CategoryLanguage
object
-
language_codestring Required -
titlestring Required -
descriptionstring Required -
slugstring Required
CategoryResponse
object
CategoryUpdatedResponse
object
-
updated_category_idsarray of string Required -
updated_article_idsarray of string Required
Clip
object
-
clip_idstring Required -
titlestring Required -
contentstring Required -
user_idstring Required -
is_privateboolean Required -
is_lockedboolean Required -
is_templateboolean Required -
created_atstring (date-time) Required Nullable
ClipResponse
object
ClipsResponse
object
CountResponse
object
-
countinteger Required
CreateArticleRequest
object
-
user_idstring -
category_idstring -
show_tocboolean -
is_privateboolean -
is_publishedboolean -
is_featuredboolean -
iconstring -
sourcestring -
permission_groupsarray of string NullableNull is the same as leaving the field out.
-
language_codestring -
titlestring -
descriptionstring -
short_versionstring -
bodystring -
slugstring -
tagsarray of string NullableNull is the same as leaving the field out.
-
is_liveboolean -
editor_typestring -
Null is the same as leaving the field out.
CreateArticleVersion
object
-
language_codestring -
titlestring -
descriptionstring -
short_versionstring -
bodystring -
slugstring -
tagsarray of string NullableNull is the same as leaving the field out.
-
is_liveboolean -
editor_typestring
CreateCategoryRequest
object
-
parent_category_idstring -
is_featuredboolean -
iconstring -
enforce_permissionsboolean -
permission_groupsarray of string NullableNull is the same as leaving the field out.
-
language_codestring -
titlestring -
descriptionstring -
slugstring -
Null is the same as leaving the field out.
CreateCategoryVersion
object
-
language_codestring -
titlestring -
descriptionstring -
slugstring
CreateClipRequest
object
-
titlestring -
contentstring -
user_idstring
CreateVariableRequest
object
-
titlestring -
valuestring
Error
object
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
GroupRequest
object
-
namestring Required
GroupResponse
object
GroupsResponse
object
Language
object
-
language_codestring Required -
namestring Required -
is_defaultboolean Required
LanguagesResponse
object
-
multilingualboolean Required
SearchResult
object
-
querystring Required -
max_scorenumber Required -
stemmed_querystring Required -
total_hitsinteger Required -
stemmedQuerystring -
totalHitsinteger
SearchResultArticle
object
-
article_idstring Required -
account_idstring Required -
titlestring Required -
slugstring Required -
descriptionstring Required -
tagsarray of string Required Nullable -
is_privateboolean Required -
is_publishedboolean Required -
permission_groupsarray of string Required Nullable -
urlstring Required -
relative_urlstring Required -
bodystring Nullable -
short_versionstring Nullable -
category_idstring Nullable -
category_titlestring Nullable -
category_titlesarray of string Nullable -
title_highlightstring Nullable -
description_highlightstring Nullable -
text_fragmentstring
SearchResultScore
object
-
scorenumber Required
SearchTerm
object
-
search_termstring Required -
countinteger Required -
original_search_termsarray of string Required Nullable -
article_idsarray of string Required Nullable -
restricted_category_idstring Required -
resultsarray of integer Required Nullable -
average_resultsnumber Required
SearchTermsResponse
object
SuccessResponse
object
-
successboolean Required
TagsResponse
object
TopArticle
object
-
article_idstring Required -
titlestring Required -
countinteger Required
TopArticlesResponse
object
UpdateArticleRequest
object
-
user_idstring NullableNull is the same as leaving the field out.
-
category_idstring NullableNull is the same as leaving the field out.
-
show_tocboolean NullableNull is the same as leaving the field out.
-
is_privateboolean NullableNull is the same as leaving the field out.
-
is_publishedboolean NullableNull is the same as leaving the field out.
-
is_featuredboolean NullableNull is the same as leaving the field out.
-
related_article_idsarray of string NullableNull is the same as leaving the field out.
-
related_autoboolean NullableNull is the same as leaving the field out.
-
is_archivedboolean NullableNull is the same as leaving the field out.
-
archive_reasonstring NullableNull is the same as leaving the field out.
-
iconstring NullableNull is the same as leaving the field out.
-
permission_groupsarray of string NullableNull is the same as leaving the field out.
-
language_codestring -
titlestring NullableNull is the same as leaving the field out.
-
descriptionstring NullableNull is the same as leaving the field out.
-
short_versionstring NullableNull is the same as leaving the field out.
-
bodystring NullableNull is the same as leaving the field out.
-
slugstring NullableNull is the same as leaving the field out.
-
tagsarray of string NullableNull is the same as leaving the field out.
-
is_liveboolean NullableNull is the same as leaving the field out.
-
editor_typestring NullableNull is the same as leaving the field out.
-
machine_translated_atstring (date-time) NullableNull is the same as leaving the field out.
-
expected_content_tokenstring NullableNull is the same as leaving the field out.
-
Null is the same as leaving the field out.
-
Null is the same as leaving the field out.
UpdateArticleVersion
object
-
language_codestring -
titlestring NullableNull is the same as leaving the field out.
-
descriptionstring NullableNull is the same as leaving the field out.
-
short_versionstring NullableNull is the same as leaving the field out.
-
bodystring NullableNull is the same as leaving the field out.
-
slugstring NullableNull is the same as leaving the field out.
-
tagsarray of string NullableNull is the same as leaving the field out.
-
is_liveboolean NullableNull is the same as leaving the field out.
-
editor_typestring NullableNull is the same as leaving the field out.
-
machine_translated_atstring (date-time) NullableNull is the same as leaving the field out.
-
expected_content_tokenstring NullableNull is the same as leaving the field out.
UpdateArticleStaleStatus
object
-
is_staleboolean -
sourcestring -
reasonstring -
expires_atstring (date-time) NullableNull is the same as leaving the field out.
UpdateCategoryRequest
object
-
parent_category_idstring NullableNull is the same as leaving the field out.
-
is_featuredboolean NullableNull is the same as leaving the field out.
-
iconstring NullableNull is the same as leaving the field out.
-
enforce_permissionsboolean NullableNull is the same as leaving the field out.
-
permission_groupsarray of string NullableNull is the same as leaving the field out.
-
language_codestring -
titlestring NullableNull is the same as leaving the field out.
-
descriptionstring NullableNull is the same as leaving the field out.
-
slugstring NullableNull is the same as leaving the field out.
-
Null is the same as leaving the field out.
UpdateCategoryVersion
object
-
language_codestring -
titlestring NullableNull is the same as leaving the field out.
-
descriptionstring NullableNull is the same as leaving the field out.
-
slugstring NullableNull is the same as leaving the field out.
UpdateClipRequest
object
-
titlestring NullableNull is the same as leaving the field out.
-
contentstring NullableNull is the same as leaving the field out.
-
is_privateboolean NullableNull is the same as leaving the field out.
-
is_lockedboolean NullableNull is the same as leaving the field out.
-
is_templateboolean NullableNull is the same as leaving the field out.
UpdateVariableRequest
object
-
titlestring NullableNull is the same as leaving the field out.
-
valuestring NullableNull is the same as leaving the field out.
-
is_lockedboolean NullableNull is the same as leaving the field out.
UploadResponse
object
-
imagestring Required -
urlstring Required
Variable
object
-
variable_idstring Required -
titlestring Required -
valuestring Required -
user_idstring Required -
is_lockedboolean Required -
created_atstring (date-time) Required Nullable
VariableResponse
object
VariablesResponse
object
OpenAPI 3.1.0