users.list

This function retrieves a list of all users for the account.

Parameters

string	api_key	(required) your api key
integer	compact	(optional) Acts as a toggle to switch between full user details being returned or a compact view. Valid values: 0 = Show full user details (non-compact) 1 = Show results in compact view (userid only)

Sample return XML (using compact=0 or omitting the compact parameter altogether)
<?xml version="1.0" encoding="UTF-8"?> <response function="users.list" status="ok"> <result_set list="true" totalResults="2"> <result> <userid>1D6964A3-1111-1701-BF3ECF3902F1FB9</userid> <firstname>Stefan</firstname> <lastname>Richter</lastname> <username>Stefan</username> <email>stefan@muchosmedia.com</email> <roleid>100</roleid> <skypename>jon123</skypename> <avatar>http://domain.com/image.jpg</avatar> </result> <result> <userid>3D69DCFB-1111-1701-BF20938FE7E2D799</userid> <firstname>Joe</firstname> <lastname>Bloggs</lastname> <username>Joey</username> <email>info@mydomain.com</email> <roleid>100</roleid> <skypename>Joe54</skypename> <avatar>http://domain.com/image.jpg</avatar> </result> </result_set> </response>

Result explanation

string	userid	globally unique identifier for this user
string	firstname	this user's first name
string	lastname	this user's last name
string	username	this user's username (will be shown when logged into a room)
string	email	this user's email address
numeric	roleid	this user's role id
string	skypename	The user's Skype username.
string	avatar	The user's profile image URL.