Skip to main content
Support

HelpDocs API

Version 1.0.0+f87e30184b32 41 Endpoints

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

    • ApiKeyBearer http bearer

      An 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.

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.

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_id string Required
  • name string Required
  • created_at string (date-time) Required Nullable
AggregateFeedback object
  • positive integer Required
  • neutral integer Required
  • negative integer Required
  • total integer Required
  • happiness integer Required
AnalyticsFeedbackResponse object
ArticleFeedback object
  • article_id string Required
  • title string Required
  • results FeedbackCounts Required Nullable
AnalyticsGraphResponse object
AnalyticsPoint object
  • date_string string
  • date number
  • article_id string
  • category_id string
  • user_id string
  • user_agent_browser string
  • user_agent_os string
  • ip_range string
  • count integer Required
  • sessions integer
Article object
  • article_id string Required
  • account_id string Required
  • user_id string Required
  • category_id string Required
  • author ArticleAuthor Required Nullable
  • title string Required
  • description string Required
  • short_version string Required
  • body string Required
  • slug string Required
  • icon string Required
  • tags array of string Required Nullable
  • show_toc boolean Required
  • is_private boolean Required
  • is_published boolean Required
  • is_archived boolean Required
  • status string Required
  • archived_at string (date-time) Nullable
  • archived_by string
  • archive_reason string
  • is_featured boolean Required
  • related_article_ids array of string Required Nullable
  • related_auto boolean Required
  • is_current_version boolean Required
  • version_number integer Required
  • source string Required
  • external_id string
  • editor_type string Required
  • stale_status ArticleStaleStatus Required Nullable
  • created_at string (date-time) Required Nullable
  • updated_at string (date-time) Required Nullable
  • permission_groups array of string Required Nullable
  • multilingual array of ArticleLanguage Required Nullable
  • url string Required
  • relative_url string Required
  • description_was_autogenerated boolean Required
  • short_version_was_autogenerated boolean Required
ArticleAuthor object
  • name string Required
  • email string
  • profile_image string Required
ArticleStaleStatus object
  • is_stale boolean Required
  • reason string Required
  • source string Required
  • triggered_at string (date-time) Required Nullable
  • expires_at string (date-time) Required Nullable
ArticleLanguage object
  • language_code string Required
  • title string Required
  • description string Required
  • short_version string Required
  • body string Required
  • slug string Required
  • tags array of string Required Nullable
  • user_id string Required
  • url string Required
  • relative_url string Required
  • is_live boolean Required
  • is_current_version boolean Required
  • version_number integer Required
  • editor_type string Required
  • machine_translated_at string (date-time) Nullable
  • has_working_copy boolean Nullable
  • created_at string (date-time) Required
  • content_token string
ArticleCountBatchResponse object
BatchCountResult object
  • id string
  • count integer Required
  • error string
ArticleCountFilter object
  • id string
  • article_id array of string Nullable

    Null is the same as leaving the field out.

  • category_id array of string Nullable

    Null is the same as leaving the field out.

  • tag array of string Nullable

    Null is the same as leaving the field out.

  • combine_tags string
  • permission_group array of string Nullable

    Null is the same as leaving the field out.

  • combine_permission_groups string
  • status array of string Nullable

    Null is the same as leaving the field out.

  • user_id array of string Nullable

    Null is the same as leaving the field out.

  • working_copy_user_id array of string Nullable

    Null is the same as leaving the field out.

  • search_term string
  • is_stale boolean Nullable

    Null is the same as leaving the field out.

  • needs_translation boolean Nullable

    Null is the same as leaving the field out.

  • outdated_translation boolean Nullable

    Null is the same as leaving the field out.

  • has_working_copy boolean Nullable

    Null is the same as leaving the field out.

  • language_code string
  • updated_at_before string
  • updated_at_after string
  • combine_filters string
  • working_copy boolean
  • only_deleted boolean
  • include_archived boolean
ArticleDiffResponse object
  • diff string Required
  • rows array of DiffRow Required
  • language_code string Required
  • from_version_number integer Required
  • to_version_number integer Required
  • left_version_number integer Required
  • right_version_number integer Required
  • generated_at string (date-time) Required
DiffRow object
  • status string Required
  • left string Required
  • right string Required
ArticleExistsResponse object
  • exists boolean Required
  • article_id string Required
FeedbackCounts object
  • positive integer Required
  • neutral integer Required
  • negative integer Required
  • total integer Required
ArticleResponse object
  • article Article Required Nullable
ArticleTagCount object
  • tag string Required
  • count integer Required
ArticleUpdatedResponse object
  • article Article Required Nullable
  • articles array of Article Required
ArticleVersion object
  • language string Required
  • version_number integer Required
  • is_current_version boolean Required
  • kind string
  • origin string
  • origin_client string
  • user_id string Required
  • body string Required
  • created_at string (date-time) Required Nullable
ArticleVersionsResponse object
  • versions array of ArticleVersion Required
  • total integer Required
  • has_more boolean Required
  • next_before integer
ArticlesResponse object
  • articles array of Article Required
BatchCountRequest object
  • filters array of ArticleCountFilter Required Nullable

    Null is the same as leaving the field out.

CategoriesResponse object
Category object
  • category_id string Required
  • account_id string Required
  • parent_category_id string Required
  • title string Required
  • description string Required
  • slug string Required
  • is_featured boolean Required
  • icon string Required
  • external_id string
  • multilingual array of CategoryLanguage Required Nullable
  • created_at string (date-time) Required Nullable
  • updated_at string (date-time) Required Nullable
  • permission_groups array of string Required Nullable
  • enforce_permissions boolean Required
  • url string Required
  • relative_url string Required
  • live_article_count integer Nullable
  • archived_article_count integer Nullable
  • name_only boolean
CategoryLanguage object
  • language_code string Required
  • title string Required
  • description string Required
  • slug string Required
CategoryResponse object
CategoryUpdatedResponse object
  • category Category Required Nullable
  • updated_category_ids array of string Required
  • updated_article_ids array of string Required
Clip object
  • clip_id string Required
  • title string Required
  • content string Required
  • user_id string Required
  • is_private boolean Required
  • is_locked boolean Required
  • is_template boolean Required
  • created_at string (date-time) Required Nullable
ClipResponse object
  • clip Clip Required Nullable
ClipsResponse object
  • clips array of Clip Required
CountResponse object
  • count integer Required
CreateArticleRequest object
  • user_id string
  • category_id string
  • show_toc boolean
  • is_private boolean
  • is_published boolean
  • is_featured boolean
  • icon string
  • source string
  • permission_groups array of string Nullable

    Null is the same as leaving the field out.

  • language_code string
  • title string
  • description string
  • short_version string
  • body string
  • slug string
  • tags array of string Nullable

    Null is the same as leaving the field out.

  • is_live boolean
  • editor_type string
  • multilingual array of CreateArticleVersion Nullable

    Null is the same as leaving the field out.

CreateArticleVersion object
  • language_code string
  • title string
  • description string
  • short_version string
  • body string
  • slug string
  • tags array of string Nullable

    Null is the same as leaving the field out.

  • is_live boolean
  • editor_type string
CreateCategoryRequest object
  • parent_category_id string
  • is_featured boolean
  • icon string
  • enforce_permissions boolean
  • permission_groups array of string Nullable

    Null is the same as leaving the field out.

  • language_code string
  • title string
  • description string
  • slug string
  • multilingual array of CreateCategoryVersion Nullable

    Null is the same as leaving the field out.

CreateCategoryVersion object
  • language_code string
  • title string
  • description string
  • slug string
CreateClipRequest object
  • title string
  • content string
  • user_id string
CreateVariableRequest object
  • title string
  • value string
Error object

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

GroupRequest object
  • name string Required
GroupResponse object
GroupsResponse object
Language object
  • language_code string Required
  • name string Required
  • is_default boolean Required
LanguagesResponse object
  • languages array of Language Required
  • multilingual boolean Required
SearchResult object
  • articles array of SearchResultArticle Required
  • query string Required
  • max_score number Required
  • stemmed_query string Required
  • total_hits integer Required
  • stemmedQuery string
  • totalHits integer
SearchResultArticle object
  • article_id string Required
  • account_id string Required
  • title string Required
  • slug string Required
  • description string Required
  • tags array of string Required Nullable
  • is_private boolean Required
  • is_published boolean Required
  • permission_groups array of string Required Nullable
  • url string Required
  • relative_url string Required
  • body string Nullable
  • short_version string Nullable
  • category_id string Nullable
  • category_title string Nullable
  • category_titles array of string Nullable
  • search SearchResultScore Nullable
  • title_highlight string Nullable
  • description_highlight string Nullable
  • text_fragment string
SearchResultScore object
  • score number Required
SearchTerm object
  • search_term string Required
  • count integer Required
  • original_search_terms array of string Required Nullable
  • article_ids array of string Required Nullable
  • restricted_category_id string Required
  • results array of integer Required Nullable
  • average_results number Required
SearchTermsResponse object
SuccessResponse object
  • success boolean Required
TagsResponse object
TopArticle object
  • article_id string Required
  • title string Required
  • count integer Required
TopArticlesResponse object
UpdateArticleRequest object
  • user_id string Nullable

    Null is the same as leaving the field out.

  • category_id string Nullable

    Null is the same as leaving the field out.

  • show_toc boolean Nullable

    Null is the same as leaving the field out.

  • is_private boolean Nullable

    Null is the same as leaving the field out.

  • is_published boolean Nullable

    Null is the same as leaving the field out.

  • is_featured boolean Nullable

    Null is the same as leaving the field out.

  • related_article_ids array of string Nullable

    Null is the same as leaving the field out.

  • related_auto boolean Nullable

    Null is the same as leaving the field out.

  • is_archived boolean Nullable

    Null is the same as leaving the field out.

  • archive_reason string Nullable

    Null is the same as leaving the field out.

  • icon string Nullable

    Null is the same as leaving the field out.

  • permission_groups array of string Nullable

    Null is the same as leaving the field out.

  • language_code string
  • title string Nullable

    Null is the same as leaving the field out.

  • description string Nullable

    Null is the same as leaving the field out.

  • short_version string Nullable

    Null is the same as leaving the field out.

  • body string Nullable

    Null is the same as leaving the field out.

  • slug string Nullable

    Null is the same as leaving the field out.

  • tags array of string Nullable

    Null is the same as leaving the field out.

  • is_live boolean Nullable

    Null is the same as leaving the field out.

  • editor_type string Nullable

    Null is the same as leaving the field out.

  • machine_translated_at string (date-time) Nullable

    Null is the same as leaving the field out.

  • expected_content_token string Nullable

    Null is the same as leaving the field out.

  • multilingual array of UpdateArticleVersion Nullable

    Null is the same as leaving the field out.

  • stale_status UpdateArticleStaleStatus Nullable

    Null is the same as leaving the field out.

UpdateArticleVersion object
  • language_code string
  • title string Nullable

    Null is the same as leaving the field out.

  • description string Nullable

    Null is the same as leaving the field out.

  • short_version string Nullable

    Null is the same as leaving the field out.

  • body string Nullable

    Null is the same as leaving the field out.

  • slug string Nullable

    Null is the same as leaving the field out.

  • tags array of string Nullable

    Null is the same as leaving the field out.

  • is_live boolean Nullable

    Null is the same as leaving the field out.

  • editor_type string Nullable

    Null is the same as leaving the field out.

  • machine_translated_at string (date-time) Nullable

    Null is the same as leaving the field out.

  • expected_content_token string Nullable

    Null is the same as leaving the field out.

UpdateArticleStaleStatus object
  • is_stale boolean
  • source string
  • reason string
  • expires_at string (date-time) Nullable

    Null is the same as leaving the field out.

UpdateCategoryRequest object
  • parent_category_id string Nullable

    Null is the same as leaving the field out.

  • is_featured boolean Nullable

    Null is the same as leaving the field out.

  • icon string Nullable

    Null is the same as leaving the field out.

  • enforce_permissions boolean Nullable

    Null is the same as leaving the field out.

  • permission_groups array of string Nullable

    Null is the same as leaving the field out.

  • language_code string
  • title string Nullable

    Null is the same as leaving the field out.

  • description string Nullable

    Null is the same as leaving the field out.

  • slug string Nullable

    Null is the same as leaving the field out.

  • multilingual array of UpdateCategoryVersion Nullable

    Null is the same as leaving the field out.

UpdateCategoryVersion object
  • language_code string
  • title string Nullable

    Null is the same as leaving the field out.

  • description string Nullable

    Null is the same as leaving the field out.

  • slug string Nullable

    Null is the same as leaving the field out.

UpdateClipRequest object
  • title string Nullable

    Null is the same as leaving the field out.

  • content string Nullable

    Null is the same as leaving the field out.

  • is_private boolean Nullable

    Null is the same as leaving the field out.

  • is_locked boolean Nullable

    Null is the same as leaving the field out.

  • is_template boolean Nullable

    Null is the same as leaving the field out.

UpdateVariableRequest object
  • title string Nullable

    Null is the same as leaving the field out.

  • value string Nullable

    Null is the same as leaving the field out.

  • is_locked boolean Nullable

    Null is the same as leaving the field out.

UploadResponse object
  • image string Required
  • url string Required
Variable object
  • variable_id string Required
  • title string Required
  • value string Required
  • user_id string Required
  • is_locked boolean Required
  • created_at string (date-time) Required Nullable
VariableResponse object
VariablesResponse object

OpenAPI 3.1.0