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 diffrent type of roles for the Teams.
{
"result": [
{
"id": "64ced5a8-c2b9-4421-821a-4e32bdfaaecc",
"title": "Contributor",
"description": "An editor or draft writer with no admin access.",
"is_system_role": true,
"role_type": 0
},
{
"id": "c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8",
"title": "Owner",
"description": "",
"is_system_role": true,
"role_type": 0
},
{
"id": "264485a9-088e-49bf-b33e-a417e9fa01e5",
"title": "Admin",
"description": "Admin has access to everything except billing.",
"is_system_role": true,
"role_type": 0
},
{
"id": "88ec9ab0-2355-46b6-8eed-b3ce2cd870a8",
"title": "None",
"description": "No content scope assigned. This role can be changed later.",
"is_system_role": true,
"role_type": 0
},
{
"id": "62810dc1-2d21-422e-bdfb-c3daebf91dd3",
"title": "Editor",
"description": "The editor can manage the articles, categories, drive, workflows, and content reuse.",
"is_system_role": true,
"role_type": 1
},
{
"id": "926c7a3c-0fe8-40c8-a96f-f02c95a12d5c",
"title": "Draft writer",
"description": "A draft writer can add or edit the articles/category pages but has limitations publishing them.",
"is_system_role": true,
"role_type": 1
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Customer API response data
The ID of the role
Name of the role
Description of role
If true, it indicates that the role is one of the system default roles.
Indicates if the role is a portal role or a content role
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.