Get
/v1/Articles/{articleId}/{langCode}/versions/{versionNumber}

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
string Required

The ID of the article

versionNumber
integer Required

Version number of the article

langCode
string Required

Language code of the article

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.

Responses
200
400
Show example

Success

Collapse all

object

data
object

id
string 

The ID of the article


title
string 

The title of the article


content
string 

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


html_content
string 

If the article editor is WYSIWYG(HTML), then the contents will be present in this property. Note: Markdown editor will also have HTML content, but the contents are readonly.


category_id
string 

The ID of the parent category of the article


project_version_id
string 

The ID of the project version where the article is located


version_number
integer 

The currently fetched version number of the article


public_version
integer 

The version number that is currently published


latest_version
integer 

The latest version number(revision) of this article


enable_rtl
boolean 

Indicates if Right to Left alignment is enabled for the article language


hidden
boolean 

Indicates if the article is visible on the site


status
integer 

Valid values[0,1,2,3,4,5]
order
integer 

The position inside the parent category


created_by
string 

The ID of the user who created the article


authors
Array of object

The list of authors who have contributed to the article


object

created_at
string 

The date on which the article was created


modified_at
string 

The date on which the article was last modified


slug
string 

The slug of the article


is_fall_back_content
boolean 

Indicates whether the article content is a fallback of the default language content or not


description
string 


article_index
object

category_type
integer 

Valid values[0,1,2]
extension_data
object

success
boolean 

Status indication for customer Api response


errors
Array of object

Errors in the customer Api response


object

warnings
Array of object

Warning in the customer Api response


object

information
Array of object

Information passed by the customer Api response


object