Method: getUsers
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can get lists of the users belonging to the departments they manage and their sub-departments.
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. |
| departmentId (optional) | int | If specified, this method selects users belonging to a specific department. |
Return Value
After the request has been completed, the system returns an object with the following properties:
| Parameter | Type | Description |
|---|---|---|
| users | UserProfile[] | An 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, Department Administrator can't get a list of users from a department they don't manage. |
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>string</groupId>
<departmentId>string</departmentId>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
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>