memberships
/groups/{group}/members [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.8000 | 5.9500 | xml, json, csv |
Description
Collection of members in the group.
Returns the list of members for a group.
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 | A comma-separated list of member IDs to return only certain members (overrides usernames) | no | longs | |
| 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 | If subgroups should be included in the response (false if members or usernames specified) | no | boolean | true |
| usernames | A comma-separated list of member usernames to return only certain members | no | strings |
Permission
This service requires reviewer or higher.
Response
This service returns a <memberships> element containing:
- The group or project common to all memberships as basic
<group>or<project>; - Each membership as a
<membership>element including the<member>and if applicable, the<details>element.
<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]"
status="normal"
role="[role]"
[subgroups="[subgroups]"]>
<member id="[member id]"
firstname="[first name]"
surname="[surname]"
username="[username]"
status="[activated|unactivated]">
<fullname>[full name]</fullname>
</member>
</membership>
<membership status="invited" ...> ... </membership>
...
</memberships>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1022 | The member does not belong to the group |
| 0x1027 | The supplied member ID is invalid |
| 0x6004 | If the member details have not been configured properly |