list group members details
/groups/{group}/members/alldetails [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.8000 | 5.9500 | xml, json, csv |
Description
Lists the members of a group and all details of their membership. See <member> for documentation on available information.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| deleted | If removed/deregistered and invited members should be included in the response (subgroups and permanently deleted not included). | no | boolean | false |
| members | To return details of specific members, submit a comma-separated list of member IDs (overrides usernames). | no | long | |
| page | The page to load (only for subgroups=false). | no | long | 1 |
| pagesize | The number of results per page (might return less results if subgroups=true). | no | long | 1000 |
| subgroups | To include subgroup members in the response (false – if members or usernames specified). | no | boolean | true |
| usernames | To return details of specific members, submit a comma-separated list of usernames. | no | strings |
Permission
This service requires manager or higher.
Response
Valid requests return the following XML:
<memberships count="[n]" [limitreached="true"]>
<group|project id="[group id]"
name="[group name]"
description="[description]"
owner="[owner]"
[relatedurl="[url]"] />
<membership id="[membership id]"
email-listed="[true|false]"
notification="[notification]"
flags="[flags]"
status="normal"
role="[role]"
[subgroups="[subgroups]"]>
<member id="[member id]"
firstname="[first name]"
surname="[surname]"
username="[username]"
flags="[flags]"
status="[activated|unactivated]">
<fullname>[full name]</fullname>
</member>
<details>
<field position="1"
name="[field name]"
editable="[true|false]"
[title="[field title]"]
[type="[field type]"]>[field value]
</field>
...
</details>
</membership>
...
</memberships>
Invalid requests return the following XML:
<memberships count="0">
<group id="12"
name="example-g"
title="g"
description="g"
owner="example"
access="member"
common="false"/>
</memberships>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x6004 | If the member details have not been configured properly |