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

Get reader groups

  • Dark
    Light

GET/readers/groups

Gets a summary of all reader groups in the project.


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

Sample Response

{
  "data": [
    {
      "reader_group_id": "0839244a-e50a-4ce0-80cf-4fb6d2caf8f8",
      "title": "Visiting faculties",
      "description": null
    },
    {
      "reader_group_id": "4c311d36-ca1e-43d4-a78b-82a3f7687a97",
      "title": "Students",
      "description": "Reader group for students"
    }
  ],
  "extension_data": null,
  "context": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Response Data

Parameter Type Description
reader_group_id string ID of the reader group.
title string The name of the reader group.
description string Description of the reader group.

Was this article helpful?

What's Next