Returns a list of user groups
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRGroupAPI | SRGroupAPI | GET, POST | Yes. |
This method returns a list of the Groups defined for a particular Luminate Online site. It supports basic list paging and sort order criteria. The list can be filtered based on Group selection mode.
Client API callers must be logged in and must be administrator users with appropriate Group Management rights. Server API callers must have "Group Management/Use Luminate Online Groups API" permission.
The MEMBERSHIP option for selection_mode does not return interests groups. To obtain a list of the constituent's interests, use instead listInterests.
See topic Common Parameters.
Optional. Indicates groups results may be cross centers in single center mode.
Type xsd:boolean.
Optional. The text that will be used to filter results.
Type xsd:string.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. Specifies a context for the results, which can differ according to how they are expected to be used
Type xsd:token.
Default is NOT_BUILT_IN.
See topic Common Parameters.
Optional. Indicates groups results may be cross centers in single center mode.
Type xsd:boolean.
Optional. The text that will be used to filter results.
Type xsd:string.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. Specifies a context for the results, which can differ according to how they are expected to be used
Type xsd:token.
Default is NOT_BUILT_IN.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<listGroupsResponse 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">
<groupInfo>
<id>0</id>
<name>Sample Group 1 Name</name>
<description>Sample Group 1 Description</description>
<statsUpdateTimestamp>2016-02-01T09:43:53.886-06:00</statsUpdateTimestamp>
<numMembers>2831</numMembers>
<numActiveMembers>2279</numActiveMembers>
<groupMode>STATIC_REBUILDABLE</groupMode>
<securityMode>ADMINISTRATOR</securityMode>
</groupInfo>
</listGroupsResponse>
JSON response
{"listGroupsResponse":{"groupInfo":{"id":"0","statsUpdateTimestamp":"2016-02-01T09:43:53.886-06:00","groupMode":"STATIC_REBUILDABLE","numActiveMembers":"2279","description":"Sample Group 1 Description","numMembers":"2831","name":"Sample Group 1 Name","securityMode":"ADMINISTRATOR"}}}