Get readers
  • 10 Nov 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Get readers

  • Dark
    Light

GET /readers

Gets all reader accounts in the project



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.

Sample Response

{
	"result": [
		{
			"reader_id": "67227159-a73f-40cc-929c-561a66f128bf",
			"first_name": "Danny",
			"last_name": "Brown",
			"email": "danny.brown@document360.io",
			"access_scope": {
				"access_level": 3,
				"categories": [],
				"project_versions": [],
				"languages": []
			},
			"associated_reader_groups": [],
			"is_invite_sso_user": false,
			"last_login_at": null
		}
	],
	"extension_data": null,
	"context": null,
	"success": true,
	"errors": [],
	"warnings": [],
	"information": []
}

Response Data

ParameterTypeDescription
reader_idstringThe ID of the reader.
first_namestringThe first name of the reader.
last_namestringThe last name of the reader.
email_idstringEmail address of the reader.
last_login_atDateTimeThe last login date and time by the reader.
access_scopeobjectThe access scope of the reader.
associated_reader_groupsstring[]An array of the group IDs the reader is associated with.
is_invite_sso_userbooleanApplicable only for SSO readers. If true, it indicates that an invitation has been sent to the reader, but the reader hasn't accepted the invitation yet.

Response Data > access_scope

ParameterTypeDescription
access_levelnumberThe access level for the reader. 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 should be given access.
project_version_idstringThe project version ID to which the category belongs.
language_codestringThe language to which the user should be given access.

Response Data > access_scope > languages

ParameterTypeDescription
project_version_idstringThe project version ID to which the user should be given access.
language_codestringThe language to which the user should be given access.

Was this article helpful?

What's Next