Table of Contents


Available since version: 1.8
This function allows you to retrieve user details based on filtering options. All parameters are optional. If parameter is set in query this option counted as ON, except if parameter is equal to NULL, Only super admins have access to all users. Admin users may see only users sharing the same user groups. Simple users may gain info only about them selfs.


nodeidsarrayNode IDs
usrgrpidsarrayUser Group IDs
useridsarrayUser IDs
mediaidsarrayMedia IDs
mediatypeidsarrayMedia type IDs
editableintegeronly with read-write permission. Ignored for SuperAdmins
filterarrayOptional filter by user fields
searcharrayReturn users by any given object field pattern
startSearchintegerSearch users field pattern only in start of the field
excludeSearchintegerExclude from result, users by given field pattern
searchWildcardsEnabledintegerSearch pattern in whole field using wildcards 1 - enable, 0 - disable
outputstringOutput options Values: shorten, refer, extend
select_usrgrpsstringSelect user groups Values: refer, extend
select_mediatypesstringSelect user media types Values: refer, extend
get_accessstringGet additional info about user access to GUI Values: shorten, refer, extend
countOutputintegerCount users, return the number of users found
preservekeysintegerReturn hash instead of array Keys of hash are object IDs
sortfieldstringSort by user field Values: userid, alias
sortorderstringSort order Values: ASC, DESC
limitintmax number of user objects to return


resultOperation successful. Result will contain array of User objects.
errorIn case of any errors


Get users details by user alias “Admin”:

	"filter":{ "alias":["Admin"] },
Retrieved user details: