Method: listGroups

Permissions to Run Request

Account Owner, Account Administrators, Department Administrators, or a custom role.

Request Parameters

Parameter	Type	Description
token (required)	string	Access token. You can obtain a token by making a request.
pageSize (optional)	string	The number of entries per page. If not indicated, equal to 1000.
pageToken (optional)	string	The token needed to continue to the next page.

Return Values

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

Parameter	Type	Description
group	array	An array containing the groupId and name values.
nextPageToken	string	The token needed to continue to the next page.

Sample Request

<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" 
xmlns:soap="https://ispringlearn.com/go/services/api/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ListGroupsRequest>
         <soap:credentials>
            <soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
         </soap:credentials>
         <soap:pageToken>string</soap:pageToken>
         <soap:pageSize>1000</soap:pageSize>
      </soap:ListGroupsRequest>
   </soapenv:Body>
</soapenv:Envelope>

XML

Sample Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
      <ns1:ListGroupsResult>
         <ns1:groups>
            <ns1:group>
               <ns1:groupId>string</ns1:groupId>
               <ns1:name>string</ns1:name>
               <ns1:isSmart>false</ns1:isSmart>
            </ns1:group>
            <ns1:group>
               ...
            </ns1:group>
         </ns1:groups>
         <ns1:nextPageToken>string</ns1:nextPageToken>
      </ns1:ListGroupsResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

XML