Get reader group
  • 06 Jul 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Get reader group

  • Dark
    Light

GET/readers/groups/{groupId}

Gets details of a reader group in the project by ID.


Parameter Type Description
api_token string REST API key you can obtain from Settings > Advanced > API tokens.

Route Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
groupId 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 object[] List of reader IDs associated with this reader group.
access_scope object Access scope of this reader group.

Response Data > associated_readers

Parameter Type Description
reader_id string ID of the reader.
first_name string First name of the reader. This value would be null until the reader logs in and updates their profile details.
last_name string Last name of the reader. This value would be null until the reader logs in and updates their profile details.
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 for the reader group. There are three levels, 1-Category, 2-Version, 3-Project.
categories object[] List of category IDs the reader group has access to.
project_versions object[] List of project version IDs the reader group has access to.

Response Data > access_scope > categories

Parameter Type Description
id string ID of the category.
title string The name of the category.

Response Data > access_scope > project_versions

Parameter Type Description
id string ID of the project version.
title string The display name of the project version.

Was this article helpful?

What's Next