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 relative URL of the article or category (without domain). For example: /docs/getting-started or /docs/page-category-v1.
When set to true, redirection rules are applied if the requested document has an active redirect. If a redirect is required, a 302 (Moved temporarily) response is returned with the new URL in the Location header. Default: true.
Success
Response for retrieving an article by URL. Extends the standard article response with available_languages and settings.
Contains details of the retrieved document, which can be an article or a category.
The unique ID of the document.
The title of the document.
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
Returns true if right-to-left text alignment is enabled for the selected language for the document.
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 position of the document within its parent category.
The list of contributors who have authored or modified the document. Each object includes contributor details such as name, email, and role.
The unique identifier of the contributor.
The contributor’s first name.
The contributor’s last name.
The email address of the contributor.
The profile logo Url of the contributor.
The date and time when the document was created.
The date and time when the document was last modified.
The slug (URL-friendly identifier) of the document.
Returns true if the document is a fallback from the default language when the requested language version is unavailable.
A short description or summary of the document.
0 - Folder, 1 - Page, 2 - Index
The editor type used for the document. Valid values: 0 - Markdown, 1 - WYSIWYG(HTML), 2 - Advanced WYSIWYG
Returns true if the document is shared through private sharing.
The translation status of the document. Valid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress
The fully qualified public URL of the document.
The current workflow status ID of the document.
The language code of the document.
Lists the languages in which the document is available, along with their translation status and URL. Each object includes:
Represents information about an available language translation for an article or category.
The language code of the translated document.
The URL of the translated document.
The translation status of the document. Valid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress
Contains SEO settings and exclusion preferences for the document.
The SEO title of the document.
The SEO description of the document.
Returns true if the document is excluded from external search engines. When enabled, Document360 automatically adds a robots meta tag and removes the document from the sitemap it generates.
Indicates the visibility level of the article.Valid values are: 0 - Public(accessible to all readers) 1 - Private(accessible only to authenticated users or specific teams).
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.
Redirect
The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid export id",
"error_code": "400",
"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.
Bad Request
The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid export id",
"error_code": "400",
"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.
Not Found
The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid export id",
"error_code": "400",
"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.