Get reader groups
  • 02 Feb 2022
  • 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.


Header

ParameterTypeDescription
api_tokenstringYou can get the REST API from Settings > Advanced > API tokens.

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

ParameterTypeDescription
reader_group_idstringThe ID of the reader group.
titlestringThe name of the reader group.
descriptionstringDescription 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

ParameterTypeDescription
access_levelnumberThe access level of the reader group. 0-None, 1-Category, 2-Version, 3-Project, 4-Language
categoriesobject[]List of category scope objects.
project_versionsstring[]List of project version IDs the reader has access to.
languagesobject[]List of language scope objects. 

Response Data > access_scope > categories

ParameterTypeDescription
category_idstringThe category ID to which the user has access.
project_version_idstringThe project version ID to which the category belongs.
language_codestringThe language to which the user has access.

Response Data > access_scope > languages

ParameterTypeDescription
project_version_idstringThe project version ID to which the user has access.
language_codestringThe language to which the user has access.

Was this article helpful?

What's Next