The Article Object
Articles returned by the API look a little like this:
// Mutable Properties
"title": "Logging In To Your HelpDocs",
"body": "<p>To improve the experience for your end users...</p>",
"multilingual": [ MultilingualArticle ],
"description": "To improve the experience for your end users...",
"short_version": "To improve the experience for your end users...",
// Calculated Properties
Some fields are mutable (you can edit them) and some are immutable (we update them for you).
When article was first created.
When article was last updated (through the dashboard or the API).
The ID of the account this article belongs to.
The ID of the category this article is displayed in.
The ID of the user that last updated this article.
A unique identifier for this article.
The title of the article
An HTML representation of the entire article body
When true, this article is only accessible via direct link.
Toggle between draft and published post.
An array of multilingual article objects. See below. 👇
The URL slug this article appears at (e.g. /article/:article_id-:slug)
A plain-text version of the article body, displayed in some themes
Usually not surfaced in themes, the short version is accessible through the API and used in some HelpDocs integrations
The fully qualified URL of this article (respecting custom domain setup)
Multilingual Article Objects
HelpDocs supports the display of articles in multiple languages. The API will return an array of multilingual article objects, each looking like this:
title: "German title",
body: "German body",
tags: ["german", "tag"],
description: "German description",
short_version: "German short version"
The fields map directly to the article fields in the table above, with the exception of is_live, which behaves like the regular is_published.