📢  Work in progress!  Select December 2025 from the Version drop-down to view the latest online help.

Get List of User Groups

Prev Next

To update user group mappings, an administrator needs to know the current user group mapping. The GetUserGroupsByUser call generates a list of user groups mapped to the user.

Format of API String

List<string> GetUserGroupsByUser(string userLogin, string loginName, string password, string tenantCode)

Data That Needs to be Supplied to the API

  • userLogin (user id) – in string format

  • loginName, password and tenantCode – user credentials to authenticate the API connection

Output

API will result below list of values

Sample Call

(”klakshmi@planful.com”,”planfuluser@gmail.com”,”planfulusertest”,”QATenant”) → Gets the list of user groups for which ‘klakshmi@planful.com’ is added.
<Get_UserGroups_By_UserResult>
string>UG!</string>
	<string>UG2</string>
	<string>Raj+Naren</string>
	<string>Test RC</string>
</Get_UserGroups_By_UserResult>