The Article Object

Updated 1 year ago by Jake Peters

Articles returned by the API look a little like this:

          {
              // Dates
              "created_at": ISODate("2016-06-26T15:30:38.731Z"),
              "updated_at": ISODate("2016-06-26T15:40:28.926Z"),
              // Identifiers
              "account_id": "test_account_id",
              "category_id": "test_category_id"
              "user_id": "test_user_id",
              "article_id": "test_article_id",
              // Mutable Properties
              "title": "Logging In To Your HelpDocs",
              "body": "<p>To improve the experience for your end users...</p>",
              "is_private": false,
              "is_published": true,
              // Calculated Properties
              "slug": "logging-in-to-your-help-docs",
              "keywords": ["login", "users"],
              "description": "To improve the experience for your end users...",
              "url": "https://support.helpdocs.io/article/test_article_id-logging-in-to-your-help-docs"
          }

Some fields are mutable (you can edit them) and some are immutable (we update them for you).

Property
created_at
Date
When article was first created.
updated_at
Date
When article was last updated (through the dashboard or the API).
account_id
String
The ID of the account this article belongs to.
category_id
String
The ID of the category this article is displayed in.
user_id
String
The ID of the user that last updated this article.
article_id
String
A unique identifier for this article.
title
String
The title of the article
body
String
An HTML representation of the entire article body
is_private
Boolean
When true, this article is only accessible via direct link.
is_published
Boolean
Toggle between draft and published post.
slug
String
The URL slug this article appears at (e.g. /article/:article_id-:slug)
keywords
String Array
Keywords we've pulled out from the article text, used to enhance search results.
description
String
A plain-text version of the article body, displayed in some themes
url
String
The fully qualified URL of this article (respecting custom domain setup)

How did we do?