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

You can obtain the list of users with the getUsers method.

Permissions to run the request: Account Owner, Account AdministratorsDepartment Administrators.

Department Administrators can get a list of users belonging only to the department they manage and its daughter departments.


Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (optional)stringIf specified, this method selects users belonging to a specific group.
departmentId (optional)intIf 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:

ParameterTypeDescription
usersUserProfile[]An array of user profiles. The UserProfile object has the same properties as the getUserProfile method.


Possible Errors

ErrorDescription
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>
  • No labels