GET /readers/groups/{groupId}
Gets details of a reader group in the project by ID.
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.
Route Parameters Parameter Required Type Description groupId Yes string The ID of the reader group.
Sample Response {
"data": {
"reader_group_id": "4c311d36-ca1e-43d4-a78b-82a3f7687a97",
"title": "Students",
"description": "Reader group for students",
"associated_readers": [
{
"reader_id": "9951f2e4-4fe3-47b9-b099-1aab99e1de76",
"first_name": null,
"last_name": null,
"email_id": "john.p@document360.com",
"last_login_at": null
},
{
"reader_id": "d7c9a42c-a1c8-40ed-bcaa-02110227b758",
"first_name": null,
"last_name": null,
"email_id": "danny.brown@document360.com",
"last_login_at": null
}
],
"access_scope": {
"access_level": 3,
"categories": [],
"project_versions": []
}
},
"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 associated with this reader group. associated_invited_sso_users string[] List of invitation IDs associated with this reader group. Applicable only for SSO users. access_scope object Access scope of this reader group.
Response Data > associated_readers Parameter Type Description reader_id string The ID of the reader. first_name string First name of the reader. last_name string Last name of the reader. email_id string Email address of the reader. last_login_at string Last login date and time. The value would be null until the reader logs in.
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
