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.
Default"1"
excludeReaders
boolean
True - Readers will be excluded; False - Readers will be included
Default"False"
Responses
200
Success
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 (AccessScopeCustomerV2)
extension_data
object (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object