AVAILABLE WITH BUSINESS SUBSCRIPTION

Method: getGroup

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles

The Author receives information about the number of users, but does not receive their IDs.

Parameters

Parameter

Type

Description

token (required)stringAccess token. You can obtain a token by making a request.
groupId (required)stringThe ID of a group you want to get info on.

Return Values

After the request has been successfully processed, the system returns an object with the following properties:

Parameter

Type

Description

grouparray

An array containing the groupId and name values (the ID of the group and its name).

Sample Request

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetGroupRequest>
      <credentials>
         <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
      </credentials>
     <groupId>cfe9248a-deb4-11e9-979c-0a580af40764</groupId>
    </GetGroupRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

Sample Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetGroupResult>
      <group>
        <groupId>e7fa2c2a-5c39-11e9-a000-0e1426fbe81a</groupId>
        <name>Sales Department</name>
      </group>
    </GetGroupResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML