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

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

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (optional)stringWhen specified, this method selects users belonging to a given group.

 

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 in the getUserProfile method.

 

Possible Errors

ErrorDescription
unknown groupA group with a given ID cannot be found.

 

Sample Call

Sample Response

  •