The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
The ID of the article
Version number 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.
Set this to false to exclude appending SAS token for images/files
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": 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?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D",
"profile_logo_cdn_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D",
"is_enterprise_user": false
}
],
"created_at": "2024-06-13T14:30:00Z",
"modified_at": "2024-06-13T14:30:00Z",
"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,
"version_created_at": "0001-01-01"
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Get article data
The ID of the article
The title of the article
If the article editor is Markdown, then the article content will be present in this property
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).
The ID of the article's parent category
The ID of the project version where the article is located
The currently fetched version number of the article
The currently published version number of the article
The latest version number of the article
True indicates that Right to Left alignment is enabled for the article language
False indicates that the article is visible on the site
The status of the article: 0 - Draft, 3 - Published
The position inside the parent category
The ID of the team account who created the article
The list of contributors in the article
The date on which the article was created
The date on which the article was last modified
The slug of the article
True indicates that the article content is a fallback of the default language content
The description of the article
0 - Folder, 1 - Page, 2 - Index
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
True indicates that the article is shared
The Translation status of the article
Latest version created date
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
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": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.