- 09 Mar 2023
- 5 Minutes to read
- Contributors
- Print
- DarkLight
Gets an article
- Updated on 09 Mar 2023
- 5 Minutes to read
- Contributors
- Print
- DarkLight
The ID of the article
Language code of the article
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.
To get latest published article, set isPublished as true.
Success
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": 2,
"order": 0,
"created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"authors": [
{
"id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"customer_id": "5b4aa245-ea69-43d3-a0bc-6dac71c318fc",
"status": 0,
"first_name": "peter",
"last_name": "jone",
"user_description": null,
"fresh_chat_restore_id": null,
"last_login_date": null,
"signup_date": null,
"unique_user_name": "peter-jone",
"is_user_existin_current_project": false,
"scheme_name": null,
"initial_tour_shown": false,
"authentication_id": null,
"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": "2023-03-08T10:40:05.3084775Z",
"modified_at": "2023-03-08T10:40:05.3084787Z",
"slug": "Knowledge-bases-are-much-easier-to-design-and edit",
"is_fall_back_content": false,
"description": null,
"article_index": null,
"category_type": 0
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
The ID of the article
The title of the article
If the article editor is Markdown, then the article contents will be present in this property
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.
The ID of the parent category of the article
The ID of the project version where the article is located
The currently fetched version number of the article
The version number that is currently published
The latest version number(revision) of this article
Indicates if Right to Left alignment is enabled for the article language
Indicates if the article is visible on the site
The position inside the parent category
The ID of the user who created the article
The list of authors who have contributed to the article
The date on which the article was created
The date on which the article was last modified
The slug of the article
Indicates whether the article content is a fallback of the default language content or not
Status indication for customer Api response
Errors in the customer Api response
Stack trace for error response message
Description for error cause
Error code for Api resonse
Warning in the customer Api response
Warning description
warning code for customer Api base response
Information passed by the customer Api response
status description for customer Api response information
Bad Request
Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.
{
"data": null,
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Article not found",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}
The ID of the article
The title of the article
If the article editor is Markdown, then the article contents will be present in this property
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.
The ID of the parent category of the article
The ID of the project version where the article is located
The currently fetched version number of the article
The version number that is currently published
The latest version number(revision) of this article
Indicates if Right to Left alignment is enabled for the article language
Indicates if the article is visible on the site
The position inside the parent category
The ID of the user who created the article
The list of authors who have contributed to the article
The date on which the article was created
The date on which the article was last modified
The slug of the article
Indicates whether the article content is a fallback of the default language content or not
Status indication for customer Api response
Errors in the customer Api response
Stack trace for error response message
Description for error cause
Error code for Api resonse
Warning in the customer Api response
Warning description
warning code for customer Api base response
Information passed by the customer Api response
status description for customer Api response information