The Group Finder service allows you to pass in a set of criteria and returns a listing of the groups that best match the criteria. It is important to note that only active non-administrative groups that are listed and available via public search will be returned. These settings can be found in the application by editing group settings and going to the options tab. Interaction Type must not be set to 'Administrative', Listed must be checked, Public Search must be checked, and Group must be active.
Service Name
group_search
Required Parameters
None
Optional Parameters
| Name | Type |
|---|---|
| area_id | integer |
| campus_id | integer |
| childcare | boolean |
| meet_day_id | integer |
| meet_time_id | integer |
| department_id | integer |
| type_id | integer |
| udf_pulldown_1_id | integer |
| udf_pulldown_2_id | integer |
| udf_pulldown_3_id | integer |
| limit_records_start | integer |
| limit_records_per_page | integer |
| order_by_1 | string |
| order_by_2 | string |
| order_by_3 | string |
| order_by_1_sort | string |
| order_by_2_sort | string |
| order_by_3_sort | string |
Example Curl
curl -u user:pass "https://yourchurch.ccbchurch.com/api.php?srv=group_search"Example Response XML
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
<request>
<parameters>
<argument value="group_search" name="srv"/>
</parameters>
</request>
<response>
<service>group_search</service>
<service_action>execute</service_action>
<availability>public</availability>
<items count="1">
<item>
<item_id type="groups">9</item_id>
<id>9</id>
<name>**Sweet Tea Junkies**</name>
<group_type_name>Interest</group_type_name>
<grouping_name>Adult Ministries</grouping_name>
<area_name ccb_id="2">North</area_name>
<meet_day_name>Monday</meet_day_name>
<meet_time_name>Lunch</meet_time_name>
<description>We like a little tea with our sugar. **DO NOT TOUCH**</description>
<status_id>1</status_id>
<messaging_type>Interact</messaging_type>
<membership_type>Open</membership_type>
<owner_name ccb_id="49">Group Leader</owner_name>
<owner_email_primary>[email protected]</owner_email_primary>
</item>
</items>
</response>
</ccb_api>