Page tree
Skip to end of metadata
Go to start of metadata

To get a list of groups, use the getGroups method.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators or users with a role with custom settings.

Parameters

Parameter

Type

Description

credentials (required)credentialsRead the description of the Credentials object.

Return Value

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

Parameter

Type

Description

grouparrayAn array containing the following values: 'groupId', 'name'. 

Sample Request

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetGroupsRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
    </GetGroupsRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

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