Get all reader groups

  • Updated on Dec 24, 2024
  • 2 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
 Prev Next
Get
/v2/Readers/groups
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 5 reader groups. The default value is 1.

Default1
excludeReaders
boolean

True - Readers will be excluded; False - Readers will be included

Defaultfalse
Responses
200

Success

Readers - Success Response for get all readers group

This is an example for 200 status, success response.

{
  "result": [
    {
      "reader_group_id": "047ec4da-d8d3-4bfe-ae83-fff9f4e1f6ae",
      "title": "ReaderGroupTitle",
      "description": "Here you can add some descriptive information regarding readers group.",
      "associated_readers": [],
      "associated_invited_sso_users": [],
      "access_scope": {
        "access_level": 3,
        "categories": [],
        "project_versions": [],
        "languages": []
      }
    }
  ],
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
Array of object (ReaderGroupCustomerV2) | null

Customer API response data

object
reader_group_id
string | null

The ID of the reader group.

title
string | null

The name of the reader group.

description
string | null

Description of the reader group.

associated_readers
Array of string | null

List of reader IDs to be associated with this reader group.

string
associated_invited_sso_users
Array of string | null

List of reader invitation IDs. Applicable only for SSO readers.

string
access_scope
object | null

Access scope of this reader group.

access_level
integer (int32)

The access level of the reader group. 0-None, 1-Category, 2-Version, 3-Project, 4-Language

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.

extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information