The GroupList function is used to list the entity hierarchy (groups and optionally users) starting at a specific point in the tree.

Normally, only Fax2Mail accounts participate in this hierarchy. An "entity" may be a user or a group. A group may be the parent of other groups and/or users. A user entity may not be the parent of another entity.

Since there may be a large number of users in some cases, this request by default only returns informations about group entities, but there is an option that will cause user information to be returned as well.

When user information is requested, a user "entity" may appear more than once if it has more than one email or fax alias, since only one "faxNumber" or "emailAddress" property is included for each user item in the result. There is an option to consolidate information for users so that each user entity only appears once, with the email and fax information appearing in the returned alias values.

In order to be able to limit the result for accounts with complex group hierarchies, the depth of the subtree that will be returned can also be limited.

This function can also be used for non-Fax2Mail accounts, but the only practical use is to obtain a list of users, since such accounts do not participate in the entity hierarchy.