Get
/v2/Articles/{articleId}/{langCode}
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters
articleId
stringRequired

The ID of the article

langCode
stringRequired

Language code of the article

Default"en"
Query parameters
isForDisplay
boolean

Set this to true, if you are displaying the article to the end-user. If true, the content of snippets or variables appears in the article. Note: If the value is true, ensure that the article content is not passed for update article endpoints.

Default"False"
isPublished
boolean

true : You will get the latest published version of the article. (If there are no published versions, then it will return the latest version)
false : To get the the latest version of the article

Default"False"
appendSASToken
boolean

Set this to false to exclude appending SAS token for images/files

Default"True"
Responses
200

Success

Sample response

This is the sample response for get-article, You can verify the information regarding the individual article.

{
  "data": {
    "id": "a1096061-e842-41fd-9085-494095e401b9",
    "title": "Knowledge bases are much easier to design and edit",
    "content": "Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.",
    "html_content": null,
    "category_id": "de104b39-db97-4509-8d4c-deeac74d448b",
    "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
    "version_number": 1,
    "public_version": 1,
    "latest_version": 2,
    "enable_rtl": false,
    "hidden": false,
    "status": 0,
    "order": 0,
    "created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "authors": [
      {
        "id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
        "first_name": "peter",
        "last_name": "jone",
        "user_description": null,
        "unique_user_name": "peter-jone",
        "email_id": "peterjone@mail.com",
        "profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E",
        "profile_logo_cdn_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E",
        "is_enterprise_user": false
      }
    ],
    "created_at": "2024-04-09T11:35:32Z",
    "modified_at": "2024-04-09T11:35:32Z",
    "slug": "Knowledge-bases-are-much-easier-to-design-and edit",
    "is_fall_back_content": false,
    "description": null,
    "category_type": 0,
    "content_type": null,
    "is_shared_article": false,
    "translation_option": 0,
    "url": "https://example.com/v1/docs/en/getting-started"
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
object (ArticleVersionDataCustomerResponse)
id
string | null

The ID of the article

title
string | null

The title of the article

content
string | null

If the article editor is Markdown, then the article content will be present in this property

html_content
string | null

If the article editor is WYSIWYG (HTML), then the content will be present in this property. Note: Markdown editor will also have HTML content (read-only).

category_id
string | null

The ID of the article's parent category

project_version_id
string | null

The ID of the project version where the article is located

version_number
integer (int32)

The currently fetched version number of the article

public_version
integer (int32)

The currently published version number of the article

latest_version
integer (int32)

The latest version number of the article

enable_rtl
boolean

True indicates that Right to Left alignment is enabled for the article language

hidden
boolean

False indicates that the article is visible on the site

status
integer (int32)

The status of the article: 0 - Draft, 3 - Published

Valid values[ 0, 3 ]
order
integer (int32)

The position inside the parent category

created_by
string | null

The ID of the team account who created the article

authors
Array of object (UserDetailsCustomer) | null

The list of contributors in the article

object
id
string | null
first_name
string | null
last_name
string | null
user_description
string | null
unique_user_name
string | null
email_id
string | null
profile_logo_url
string | null
profile_logo_cdn_url
string | null
is_enterprise_user
boolean
created_at
string (date-time)

The date on which the article was created

modified_at
string (date-time)

The date on which the article was last modified

slug
string | null

The slug of the article

is_fall_back_content
boolean

True indicates that the article content is a fallback of the default language content

description
string | null

The description of the article

category_type
integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[ 0, 1, 2 ]
content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
is_shared_article
boolean

True indicates that the article is shared

translation_option
integer (int32)

0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress

Valid values[ 0, 1, 2, 3 ]
url
string | null

Url of the article

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string | null

status description for customer Api response information

400

Bad Request

Article not found

Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Article not found",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string | null

status description for customer Api response information