You can obtain the list of users with the getUsers method.
Permission to run the request: Account Owner, Administrator, Organization Administrator.
Parameters
Parameter | Type | Description |
---|
credentials (required) | credentials | Read the description of the Credentials object. |
groupId (optional) | string | If specified, this method selects users belonging to a specific group. |
organizationId (optional) | int | If specified, this header selects users belonging to a specific organization. |
Return Value
After the request has been completed, the system returns an object with the following properties:
Parameter | Type | Description |
---|
users | UserProfile[] | Array of user profiles. The UserProfile object has the same properties as the getUserProfile method. |
Possible Errors
Error | Description |
---|
Permission denied | The user doesn't have enough permissions to handle the request. For example, an organization admin can't request info about users from another organization. |
Sample Call
<?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>
<GetUsersRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
</GetUsersRequest>
<groupId>1</groupId>
<organizationId>2</organizationId>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
Sample Response
<?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>
<GetUsersResult>
<userProfile>
<userId>string</userId>
…
</userProfile>
<userProfile>
<userId>string</userId>
…
</userProfile>
</GetUsersResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML