Get
/v2/Readers
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Query parameters
offSet
integer (int32)

Specify the pagination to be retrieved. Each pagination retrieves 5000 readers. The default value is 1.

Default"1"
searchEmail
string
Responses
200

Success

Readers - 200 Success response for Update reader groups

This is a sample success status response example.

{
  "reader_id": "91b70808-3d15-45e0-a641-f03e2a0b0efd",
  "first_name": "Peter",
  "last_name": "Jone",
  "email": "peterjone@mail.com",
  "access_scope": {
    "access_level": 3,
    "categories": [],
    "project_versions": [],
    "languages": []
  },
  "associated_reader_groups": [],
  "is_invite_sso_user": false,
  "last_login_at": null
}
Expand All
object
reader_id
string | null

The ID of the reader.

first_name
string | null

The first name of the reader.

last_name
string | null

The last name of the reader.

email
string | null

Email address of the reader.

access_scope
object (AccessScopeCustomerV2)
access_level
integer (int32)

This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6 ]
categories
Array of object (CategorySummaryCustomerV2) | null

List of category scope objects.

object
category_id
string | null

The category ID to which the user should be given access.

project_version_id
string | null

The project version ID to which the category belongs.

language_code
string | null

The language to which the user should be given access.

project_versions
Array of string | null

List of project version IDs the reader has access to.

string
languages
Array of object (LanguageSummaryCustomer) | null

List of language scope objects.

object
project_version_id
string | null

The project version ID to which the user should be given access.

language_code
string | null

The language to which the user should be given access.

associated_reader_groups
Array of string | null

An array of the group IDs the reader is associated with.

string
is_invite_sso_user
boolean

Applicable 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.

last_login_at
string (date-time) | null

The last login date and time by the reader.