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.
Success
The below example shows a successful response with workflow statuses for the project.
{
"data": [
{
"id": "6ea2c8d5-1c81-4981-8ed3-d41b1fc5ab7d",
"name": "Draft",
"description": "Initial draft status for new items",
"read_only": false
},
{
"id": "65545e06-8c41-4e1a-a090-c603f9f1b4b2",
"name": "In Review",
"description": "Check for grammar and spellings, edit formatting and give feedback",
"read_only": true
},
{
"id": "ec0a4d2a-bb13-4c55-867e-1e9e0be07086",
"name": "Published",
"description": "Live,visible in KB",
"read_only": true
},
{
"id": "66e6cbc7-009b-4e11-883a-65ffec66b43a",
"name": "Unpublished",
"description": "",
"read_only": true
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Contains the list of workflow statuses configured for the current project. Each object represents a single workflow status definition.
Unique identifier of the workflow status. This ID is used while updating the workflow status for articles and page categories using the Update workflow status of articles and Update workflow status of page categories endpoints respectively.
Display name of the workflow status (e.g., "Draft", "In Review"). The workflow status is displayed to all team accounts working on the article.
Optional explanation of the status. Used to clarify the intent or usage of the status in the workflow. May be blank if no description was provided during setup.
Indicates whether read-only mode is toggled on for the workflow status.
• true: workflow status is set to read-only.No edits can be made to the article.No comments can be added to the article.
• false: Contributors can edit the article and add comments to the article to provide feedback.
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 an error response when the project ID is invalid or not found.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid project ID or project not found",
"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.