Gets a summary of all reader groups in the project.
Header Parameter Type Description api_token string You can get the REST API from Settings > Advanced > API tokens .
Query Parameters Parameter Required Type Description offSet No int Used for pagination. The default value is 1.
Sample Response {
"result": [
{
"reader_group_id": "5c09f34d-fdbb-4e80-90f1-a9640fc6be78",
"title": "Visiting faculties",
"description": "",
"associated_readers": [],
"associated_invited_sso_users": [],
"access_scope": {
"access_level": 3,
"categories": [],
"project_versions": [],
"languages": []
}
},
{
"reader_group_id": "0861eece-60e5-4f01-9761-e208f070ac98",
"title": "Students",
"description": "",
"associated_readers": [],
"associated_invited_sso_users": [],
"access_scope": {
"access_level": 2,
"categories": [],
"project_versions": [
"fd1a5604-70e2-4169-b19a-1e1aeb4f8094"
],
"languages": []
}
}
],
"extension_data": null,
"context": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Response Data Parameter Type Description reader_group_id string The ID of the reader group. title string The name of the reader group. description string Description of the reader group. associated_readers string[] List of reader IDs to be associated with this reader group. associated_invited_sso_users string[] List of reader invitation IDs. Applicable only for SSO readers. access_scope object Access scope of this reader group.
Response Data > access_scope Parameter Type Description access_level number The access level of the reader group. 0-None, 1-Category, 2-Version, 3-Project, 4-Language categories object[] List of category scope objects. project_versions string[] List of project version IDs the reader has access to. languages object[] List of language scope objects.
Response Data > access_scope > categories Parameter Type Description category_id string The category ID to which the user has access. project_version_id string The project version ID to which the category belongs. language_code string The language to which the user has access.
Response Data > access_scope > languages Parameter Type Description project_version_id string The project version ID to which the user has access. language_code string The language to which the user has access.
Was this article helpful?
Thank you for your feedback! Our team will get back to you
