Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
The ID of the project version
Get article in the project version that corresponds to the given language code. If the language code is empty, the default language of the project version will be taken into account
Success
200 response in get list of articles within project version
{
"data": [
{
"url": "https://example.com/v1/docs/en/getting-started",
"id": "7db99386-2816-40f0-991f-174dgdscf",
"title": "Why did we build Document360?",
"public_version": 1,
"latest_version": 1,
"language_code": null,
"hidden": false,
"status": 0,
"order": 1,
"slug": "why did we build document360",
"content_type": null,
"translation_option": 0,
"is_shared_article": false,
"modified_at": null
}
],
"extension_data": null,
"success": false,
"errors": [],
"warnings": [],
"information": []
}Url of the article
The ID of the article
The article title
The article version number(revision) that is currently published
The latest version number of this article
The default language code
Indicates if the article is visible on the site
The status of the article: 0 - Draft, 3 - Published
The position of the article inside the parent category
The slug of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress
True indicates that the article is shared
Article modified date time
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 response
Warnings 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
400 bad response due to invalid Project version Id
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The supplied project version id does not exist in your project",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}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 response
Warnings 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