The Family List service allows you to retrieve a list of families and their members. Results may be filtered by family ID or by a modified since date.
Service Name
family_list
Required Parameters
None
Optional Parameters
| Name | Type |
|---|---|
| family_id | int |
| modified_since | datetime |
Example Curl
curl -u user:pass "https://yourchurch.ccbchurch.com/api.php?srv=family_list&modified_since=2014-07-22"Example Response XML
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
<request>
<parameters>
<argument value="family_list" name="srv"/>
<argument value="2014-07-22" name="modified_since"/>
</parameters>
</request>
<response>
<service></service>
<service_action>execute</service_action>
<availability>public</availability>
<families count="6">
<family id="2468">
<individuals count="16">
<individual id="2770">
<first_name>Christopher</first_name>
<last_name>Marshall</last_name>
<type>other</type>
</individual>
...
<individual id="2485">
<first_name>Amanda</first_name>
<last_name>Marshall</last_name>
<type>other</type>
</individual>
</individuals>
<modified>2014-07-22 13:40:09</modified>
</family>
...
<family id="3020">
<individuals count="1">
<individual id="3579">
<first_name>Erica</first_name>
<last_name>Smith</last_name>
<type>primary contact</type>
</individual>
</individuals>
<modified>2014-07-22 07:34:23</modified>
</family>
</families>
</response>
</ccb_api>