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

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

Permission to run the request: Account Owner, Administrator, Organization Administrator. 

 

Parameters

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

 

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
Permission denied

Not enough permissions to handle the request.

Example: Organization admin can't request info about users from another organization.

 

Sample Call

Sample Response

  •