This method returns the list of the constituents in a group. By default, each group member's constituent ID, member ID, first and last names, primary email address and home address are returned.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRConsAPI | SRConsAPI | POST | Yes. |
This method returns personal information for members of a user group. It is only available for administrative users having the appropriate permission to review member lists. If this method is called as a Client API, the administrator must be logged in and an authentication token must be provided in the request.
By default, the method returns constituent ID, member ID, name, primary mailing address and primary email address. The fields parameter can be used to specify a comma-separated list of other fields from the constituent record.The listUserFields method returns the list of available fields, which may differ from one Luminate Online site to another.
See topic Common Parameters.
Required. The Group ID key referencing the Group record.
Type xsd:nonNegativeInteger.
Optional. A comma-separated list of field names of constituent record fields to return for each member.
Type xsd:string.
Default is cons_id, member_id, first_name, last_name, primary_email, home_street1, home_street2, home_street3, home_city, home_stateprov, home_county, home_zip.
Optional. The maximum number of members to return (up to 1000).
Type xsd:nonNegativeInteger.
Default is 1000.
See topic Common Parameters.
Required. The Group ID key referencing the Group record.
Type xsd:nonNegativeInteger.
Optional. A comma-separated list of field names of constituent record fields to return for each member.
Type xsd:string.
Default is cons_id, member_id, first_name, last_name, primary_email, home_street1, home_street2, home_street3, home_city, home_stateprov, home_county, home_zip.
Optional. The maximum number of members to return (up to 1000).
Type xsd:nonNegativeInteger.
Default is 1000.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<getGroupMembersResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<total_number>2</total_number>
<number_returned>2</number_returned>
<member>
<cons_id>1000121</cons_id>
<member_id>Member ID</member_id>
<name>
<first>First</first>
<last>Last</last>
</name>
<email>
<primary_address>email@address.net</primary_address>
</email>
<primary_address>
<street1>Street1</street1>
<street2>Street2</street2>
<street3>Street3</street3>
<city>City</city>
<state>State</state>
<zip>Zip</zip>
<county>County</county>
</primary_address>
</member>
</getGroupMembersResponse>
JSON response
{"getGroupMembersResponse":{"member":{"primary_address":{"street2":"Street2","zip":"Zip","street1":"Street1","county":"County","state":"State","street3":"Street3","city":"City"},"email":{"primary_address":"email@address.net"},"name":{"last":"Last","first":"First"},"cons_id":"1000121","member_id":"Member ID"},"number_returned":"2","total_number":"2"}}