Get reader group
  • 10 Nov 2022
  • 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.


Header

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

Query Parameters

ParameterRequiredTypeDescription
offSetNointUsed for pagination. The default value is 1.

Route Parameters

ParameterRequiredTypeDescription
groupIdYesstringThe 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

ParameterTypeDescription
reader_group_idstringThe ID of the reader group.
titlestringThe name of the reader group.
descriptionstringDescription of the reader group.
associated_readersstring[]List of reader IDs associated with this reader group.
associated_invited_sso_usersstring[]
List of invitation IDs associated with this reader group. Applicable only for SSO users. 
access_scopeobjectAccess scope of this reader group.

Response Data > associated_readers

ParameterTypeDescription
reader_idstringThe ID of the reader.
first_namestringFirst name of the reader.
last_namestringLast name of the reader.
email_idstringEmail address of the reader.
last_login_atstringLast login date and time. The value would be null until the reader logs in.

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