users.list
This function retrieves a list of all users for the account.
Parametersstring | 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)
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 | 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. |