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

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

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

 

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.
statusintUser status 1 - active, 2 - deleted, 3 - inactive.
organizationIdintOrganization ID to which a user belongs.
deactivationDatedateUser's deactivation date
groupsstring[]An array of group IDs, to which a given user belongs.
fieldsstring[][2]Fields of user profile (UserFields) - An array of objects with the following properties: name, value.

 

Possible Errors

ErrorDescription
Unknown userA user with a given ID cannot be found
Permission deniedYou do not have enough permissions to get user info.

Sample Call

Sample Response

  •