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
Here, you can verify the folder’s information.
{
"data": [
{
"id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"title": "Document",
"parent_folder_id": "fsf41c-0f94-4b04-a8b6-a14bb1995eca",
"sub_folders": [
{
"id": "d8b65d24-ce62-407a-8463-846efc8eee93",
"title": "Images",
"parent_folder_id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"sub_folders": [],
"items_count": 0,
"updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"updated_on": "2024-06-13T14:30:00Z",
"order": 2,
"is_starred": true
}
],
"items_count": 1,
"updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"updated_on": "2024-06-13T14:30:00Z",
"order": 1,
"is_starred": true
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Dive folders meta
This is the folder Id
This is the folder title
The parent folder ID
The sub folders in the parent
The items in the folder
The ID of the user that created the folder
The date the folder was created
The order of the folder
This denotes the folder is starred or not
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 the given folder is valid and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [],
"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.