Get
/v2/Readers/groups/{groupId}
Security
API Key
Header parameter nameapi_token

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

Path parameters
groupId
stringRequired

The ID of the reader group

Query parameters
offSet
integer (int32)

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

Default"1"
Responses
200
400
Show example

Success

Collapse all
object
result
object (ReaderGroupCustomerV2)
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