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

You can obtain information about a user with the getUserProfile method.

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
userId (required)stringID of a user, whose information you want to get.

 

Return Value

After the request has been completed, the system returns an object with the following properties.

ParameterTypeDescription
userIdstringID of the specified user.
emailstringE-mail address of the specified user.
namestringName of the specified user.
countrystringCountry of the specified user.
postalCodestringPostal Code of the specified user.
citystringCity of the specified user.
statestringState of the specified user.
cellPhonestringCell phone number of the specified user.
phonestringPhone number of the specified user.
faxstringFax number of the specified user.
address1stringFirst address line of the specified user.
address2stringSecond address line of the specified user.
groupsstring[]An array of group IDs, to which a given user belongs.

 

Possible Errors

ErrorDescription
unknown usera user with a given ID cannot be found

Sample Call

 

Sample Response

  •