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 ID of the reader group
Specify the pagination to be retrieved. Each pagination retrieves 5000 readers. The default value is 1.
Success
This is an example for 200 status, success response.
{
"result": {
"reader_group_id": "1c8e9f29-33e8-4301-af1d-dbf3c15a2782",
"title": "ReadersGroupTitle",
"description": "This is the Readers Group Description.",
"associated_readers": [],
"associated_invited_sso_users": [],
"access_scope": {
"access_level": 3,
"categories": [],
"project_versions": [],
"languages": []
}
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
Customer API response data
The ID of the reader group.
The name of the reader group.
Description of the reader group.
List of reader IDs to be associated with this reader group.
List of reader invitation IDs. Applicable only for SSO readers.
Access scope of this reader group.
The access level of the reader group. 0-None, 1-Category, 2-Version, 3-Project, 4-Language
List of category scope objects.
The category ID to which the user should be given access.
The project version ID to which the category belongs.
The language to which the user should be given access.
List of project version IDs the reader has access to.
List of language scope objects.
The project version ID to which the user should be given access.
The language to which the user should be given access.
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 your readers group Id and perform the operation again. This seems to be an error while finding the reader group Id, to find your readers group Id from /v2/Readers/groups.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The reader group Id does not exist.",
"error_code": null,
"custom_data": null
}
],
"warnings": null,
"information": null
}
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.