### Campus Profile Service Examples

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Examples for the campus_profile service using cURL and XML.

```bash
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=campus_profile&id=1"
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="campus_profile" name="srv"/>
      <argument value="1" name="id"/>
    </parameters>
  </request>
  <response>
    <service></service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <campus id="1">
      <name>Church of Cucumbers</name>
      <addresses>
        <address type="mailing">
          <name></name>
          <street_address></street_address>
          <city></city>
          <state></state>
          <zip></zip>
          <country code=""></country>
          <line_1></line_1>
          <line_2></line_2>
        </address>
        <address type="meet_at">
          <name>Your Church Name</name>
          <street_address>Your Address</street_address>
          <city>City</city>
          <state></state>
          <zip></zip>
          <country code=""></country>
          <line_1>Your Address</line_1>
          <line_2>City</line_2>
        </address>
      </addresses>
      <email></email>
      <phones>
        <phone type="mobile">(555) 555-5555</phone>
      </phones>
      <campus_group id="7">
        <name>All members of CC</name>
        <url>https://yourchurch.ccbchurch.com/group_detail.php?group_id=7</url>
      </campus_group>
      <locale>en_US</locale>
      <timezone>America/Denver</timezone>
      <currency>dollar</currency>
      <active>1</active>
      <creator id="0">System User</creator>
      <modifier id="1">System User</modifier>
      <created>2010-05-07 15:30:41</created>
    </campus>
  </response>
</ccb_api>
```

--------------------------------

### Campus List Service Examples

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Examples for the campus_list service using cURL and XML.

```bash
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=campus_list"
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="campus_list" name="srv"/>
    </parameters>
  </request>
  <response>
    <service>campus_list</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <campuses count="9">
      <campus id="1">
        <name>Church of Cucumbers</name>
        <active>1</active>
        <creator id="0">System User</creator>
        <modifier id="1">System User</modifier>
        <created>2010-05-07 15:30:41</created>
      </campus>
      …
      <campus id="12">
        <name>Mountain</name>
        <active>1</active>
        <creator id="1">System User</creator>
        <modifier id="1">System User</modifier>
        <created>2012-11-08 13:47:12</created>
      </campus>
    </campuses>
  </response>
</ccb_api>
```

--------------------------------

### Community Login Service Examples

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Examples for the individual_id_from_login_password service using cURL and XML.

```bash
  curl -u user:pass -d "login=myusername&password=mypassword" "https://yourchurch.ccbchurch.com/api.php?srv=individual_id_from_login_password"
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="individual_id_from_login_password" name="srv"/>
      <argument value="example" name="login"/>
      <argument value="example" name="password"/>
    </parameters>
  </request>
  <response>
    <items count="1">
      <item>
        <item_id type="individual">48</item_id>
        <id>48</id>
      </item>
    </items>
  </response>
</ccb_api>
```

--------------------------------

### Get Individual Notes XML Response

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example XML response for retrieving individual notes. Shows individual details and any associated notes.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="individual_notes" name="srv"/>
      <argument value="48" name="individual_id"/>
    </parameters>
  </request>
  <response>
    <service>individual_notes</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <individuals count="1">
      <individual id="48">
        <name>Larry Bob</name>
        <campus id="1">Church of Cucumbers</campus>
        <notes/>
      </individual>
    </individuals>
  </response>
</ccb_api>
```

--------------------------------

### Execute Search XML Example

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example XML request and response structure for the execute_search service.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="execute_search" name="srv"/>
      <argument value="1" name="id"/>
    </parameters>
  </request>
  <response>
    <service>execute_search</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <individuals count="396">
    …see individual profiles…
    </individuals>
  </response>
</ccb_api>
```

--------------------------------

### Valid Individuals API Examples

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Examples for retrieving a list of all individuals within the system.

```curl
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=valid_individuals"
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
     <parameters>
        <argument value="valid_individuals" name="srv"/>
     </parameters>
  </request>
  <valid_individuals count="58">
    <valid_individual id="1">
      <active>true</active>
      <creator id="1">Larry Cucumber</creator>
      <modifier id="1">Larry Cucumber</modifier>
      <created>2003-11-26 13:03:43</created>
      <modified>2014-01-07 12:02:31</modified>
    </valid_individual>
    …
    <valid_individual id="62">
      <active>true</active>
      <creator id="1">Larry Cucumber</creator>
      <modifier id="0">System User</modifier>
      <created>2013-04-08 06:50:44</created>
      <modified>2013-07-23 03:28:18</modified>
    </valid_individual>
  </valid_individuals>
</ccb_api>
```

--------------------------------

### Attendance Profile Service Examples

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Examples for retrieving attendance information for a specific event occurrence.

```curl
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=attendance_profile&id=756&occurrence=2014-01-27"
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="attendance_profile" name="srv"/>
      <argument value="756" name="id"/>
      <argument value="2014-01-27" name="occurrence"/>
    </parameters>
  </request>
  <response>
    <events count="1">
      <event id="756">
        <name>Every. day. part 2</name>
        <occurrence>2014-01-27 00:00:00</occurrence>
        <did_not_meet>false</did_not_meet>
        <topic></topic>
        <notes></notes>
        <prayer_requests></prayer_requests>
        <info></info>
        <attendees>
          <attendee id="10">
            <first_name>Ben</first_name>
            <last_name>Bolton</last_name>
          </attendee>
          <attendee id="25">
            <first_name>Ben</first_name>
            <last_name>Boltontest</last_name>
          </attendee>
        </attendees>
        <head_count></head_count>
      </event>
    </events>
  </response>
</ccb_api>
```

--------------------------------

### Get Individual Groups XML

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example XML response for retrieving an individual's groups. This shows the structure of group data associated with an individual.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="individual_groups" name="srv"/>
      <argument value="48" name="individual_id"/>
    </parameters>
  </request>
  <response>
    <service>individual_groups</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <individuals count="1">
      <individual>
        <individual_id type="individual">48</individual_id>
        <id>48</id>
        <name_first>Larry</name_first>
        <name_last>Bob</name_last>
        <full_name>Larry Bob</full_name>
        <receive_email_from_church>1</receive_email_from_church>
        <groups count="3">
          <group>
            <group_id type="groups">1</group_id>
            <id>1</id>
            <name>Entire Church Group</name>
            <receive_email_from_group>1</receive_email_from_group>
            <receive_sms_from_group></receive_sms_from_group>
            <notify_comments></notify_comments>
          </group>
          …
          <group>
            <group_id type="groups">23</group_id>
            <id>23</id>
            <name>**Ninja Turtle Club**</name>
            <receive_email_from_group>1</receive_email_from_group>
            <receive_sms_from_group></receive_sms_from_group>
            <notify_comments>1</notify_comments>
          </group>
        </groups>
      </individual>
    </individuals>
  </response>
</ccb_api>
```

--------------------------------

### Public Calendar Listing XML Example

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example XML structure for a public calendar listing request and response.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="public_calendar_listing" name="srv"/>
      <argument value="2008-11-25" name="date_start"/>
    </parameters>
  </request>
  <response>
    <items count="1">
      <item>
        <date>2008-11-25</date>
        <event_name ccb_id="586">a really fun event</event_name>
        <event_description></event_description>
        <start_time>00:00:00</start_time>
        <end_time>00:15:00</end_time>
        <event_duration>15</event_duration>
        <event_type>Registration Required</event_type>
        <location></location>
        <group_name ccb_id="8">Awesome Group For Fun People</group_name>
        <group_type>Life Group</group_type>
        <grouping_name>FUN GROUPING</grouping_name>
        <leader_name ccb_id="841">Larry Boy</leader_name>
        <leader_phone>(123) 938-5555</leader_phone>
        <leader_email>lboy@test.com</leader_email>
      </item>
    </items>
  </response>
</ccb_api>
```

--------------------------------

### Lookup Table Service API Examples

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Examples for performing CRUD operations on lookup tables. Invalid IDs in update operations will return empty elements instead of errors.

```curl
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=ability_detail&ability_id=9"
```

```curl
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=ability_insert&name=newValue&order_by=3"
```

```curl
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=ability_list"
```

```curl
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=ability_update&ability_id=9&name=BOOKKEEPING"
```

--------------------------------

### Update Individual Fit API Examples

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Examples for updating an individual's fit attributes. Note that this operation overwrites all existing values for the specified individual.

```curl
  curl -u user:pass "https://yourchurch.ccbchurch.com/api.php?srv=update_individual_fit&individual_id=1" -d "spiritual_gifts[1]=1&abilities[1]=1&abilities[2]=4"
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
   <request>
      <parameters>
         <argument value="individual_fit" name="srv"/>
      </parameters>
   </request>
   <response>
      <service>individual_profiles</service>
      <service_action>execute</service_action>
      <availability>public</availability>
      <individuals count="1">
        <individual id="1">
         <individuals count="1">
          <individual id="1">
            <abilities count="2">
              <ability id="1">Skill: Medical</ability>
              <ability id="4">Skill: Education</ability>
            </abilities>
            <spiritual_gifts count="1">
              <spiritual_gift id="1">Administration</spiritual_gift>
            </spiritual_gifts>
            <passions count="0"></passions>
        </individual>
      </individuals>
   </response>
</ccb_api>
```

--------------------------------

### Batch Import XML Structure

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example XML structure required for the import_batches service.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
     <batch id="19">
          <campus id="1"></campus>
          <post_date>2013-11-12</post_date>
          <transactions>
               <transaction id="44" merchant_transaction_id="abc-123">
                    <individual id="48"></individual>
                    <date>2006-05-04</date>
                    <grouping id="1"></grouping>
                    <payment_type>Cash</payment_type>
                    <check_number></check_number>
                    <merchant_name></merchant_name>
                    <merchant_individual_id></merchant_individual_id>
                    <transaction_details>
                         <transaction_detail id="44">
                              <coa id="1"></coa>
                              <amount>250.32</amount>
                              <note>note0</note>
                         </transaction_detail>
                         <transaction_detail id="45">
                              <coa id="2"></coa>
                              <amount>10.35</amount>
                              <note></note>
                         </transaction_detail>
                    </transaction_details>
               </transaction>
               <transaction id="45">
                    <campus id="2"></campus>
                    <individual id="50"></individual>
                    <date>2006-05-04</date>
                    <grouping id=""></grouping>
                    <payment_type>Check</payment_type>
                    <check_number>1234</check_number>
                    <merchant_name></merchant_name>
                    <merchant_individual_id></merchant_individual_id>
                    <transaction_details>
                         <transaction_detail id="46">
                              <coa id="2"></coa>
                              <amount>10</amount>
                              <note></note>
                         </transaction_detail>
                    </transaction_details>
               </transaction>
          </transactions>
     </batch>
</ccb_api>
```

--------------------------------

### Queue List XML Response

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example XML structure returned by the queue_list service.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="queue_list" name="srv"/>
      <argument value="2" name="id"/>
    </parameters>
  </request>
  <queues count="7">
    <queue id="18">
      <name>1. Thank-You Letter</name>
      <description>This letter is sent by our volunteer letter team to thank the new guest for attending our church services, encouraging them to return  and providing information on our service schedule.</description>
      <process id="2">New Guest Followup</process>
      <order>1</order>
      <managers/>
      <creator id="1">Larry Cucumber</creator>
      <modifier id="1">Larry Cucumber</modifier>
      <created>2007-08-14 10:19:40</created>
      <modified>2011-09-20 08:08:01</modified>
    </queue>
    …
    <queue id="24">
      <name>7. Outreach Coordinator Review</name>
      <description>The Outreach Coordinator will review all the contact made and any notes added to determine if any additional contact should be made  or the guest should be added to another process</description>
      <process id="2">New Guest Followup</process>
      <order>30</order>
      <managers/>
      <creator id="1">Larry Cucumber</creator>
      <modifier id="1">Larry Cucumber</modifier>
      <created>2007-08-14 10:40:53</created>
      <modified>2010-07-27 12:55:10</modified>
    </queue>
  </queues>
</ccb_api>
```

--------------------------------

### GET individual_calendar_listing

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Retrieves a list of calendar events for a specific individual starting from a given date.

```APIDOC
## GET individual_calendar_listing

### Description
Retrieves a list of calendar events for a specific individual starting from a given date.

### Method
GET

### Parameters
#### Query Parameters
- **srv** (string) - Required - Must be set to "individual_calendar_listing"
- **date_start** (date) - Required - The start date for the calendar listing (YYYY-MM-DD)
- **id** (integer) - Required - The ID of the individual

### Response
#### Success Response (200)
- **item** (array) - A list of event objects containing date, event_name, event_description, start_time, end_time, and leader details.
```

--------------------------------

### Get Individual Notes cURL Request

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example cURL command to retrieve notes for a specific individual. The individual_id parameter is required.

```curl
curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=individual_notes&individual_id=48"
```

--------------------------------

### GET batch_profiles_in_date_range

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Retrieves all batches with a post date within a specified range. If no end date is provided, it defaults to the start date.

```APIDOC
## GET batch_profiles_in_date_range

### Description
Retrieves all batches with a post date within a specified range. If no end date is provided, it defaults to the start date.

### Method
GET

### Endpoint
/api.php?srv=batch_profiles_in_date_range

### Parameters
#### Query Parameters
- **date_start** (datetime) - Required - The start date for the batch search.
- **date_end** (datetime) - Optional - The end date for the batch search.
```

--------------------------------

### Create Individual via cURL

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example of how to create an individual using a cURL command with HTTP POST parameters.

```bash
curl -u user:pass -d "first_name=Ken&last_name=Scott&campus_id=0&family_id=0&family_position=c&gender=m&birthday=2%2F12%2F1966&anniversary=May+6%2C+1989&membership_date=2010-01-01&email=ken%40test.net&mailing_street_address=12265+Oracle+Blvd%2C+Suite+105&mailing_city=Colorado+Springs&mailing_state=CO&mailing_zip=80921&mailing_country=US&mobile_phone=719-266-2888" "https://yourchurch.ccbchurch.com/api.php?srv=create_individual"
```

--------------------------------

### Get Individual Profile cURL Request

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example cURL command to fetch an individual's profile using their ID. The individual_id parameter is mandatory.

```curl
curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=individual_profile_from_id&individual_id=48"
```

--------------------------------

### Create Individual XML Response

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example XML structure returned by the create_individual service, detailing individual profile data and privacy settings.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="create_individual" name="srv"/>
    </parameters>
  </request>
  <response>
    <service>create_individual</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <individuals count="1">
      <individual id="63">
        <sync_id></sync_id>
        <other_id></other_id>
        <giving_number></giving_number>
        <campus id="1">Church of Cucumbers</campus>
        <family id="49">The Scott Family</family>
        <family_image>https://cdn3.ccbchurch.com/preSTABLE/images/group-default.gif</family_image>
        <family_position>Primary Contact</family_position>
        <family_members/>
        <first_name>Ken</first_name>
        <last_name>Scott</last_name>
        <middle_name></middle_name>
        <legal_first_name></legal_first_name>
        <full_name>Ken Scott</full_name>
        <salutation></salutation>
        <suffix></suffix>
        <limited_access_user>1</limited_access_user>
        <image>https://cdn3.ccbchurch.com/preSTABLE/images/profile-default.gif</image>
        <email>ken@test.net</email>
        <allergies></allergies>
        <confirmed_no_allergies>false</confirmed_no_allergies>
        <addresses>
          <address type="mailing">
            <street_address>12265 Oracle Blvd, Suite 105</street_address>
            <city>Colorado Springs</city>
            <state>CO</state>
            <zip>80921</zip>
            <country code="US">United States</country>
            <line_1>12265 Oracle Blvd, Suite 105</line_1>
            <line_2>Colorado Springs, CO 80921</line_2>
            <latitude>39.010822</latitude>
            <longitude>-104.815760</longitude>
          </address>
          <address type="home">
            <street_address></street_address>
            <city></city>
            <state></state>
            <zip></zip>
            <country code=""> </country>
            <line_1></line_1>
            <line_2></line_2>
          </address>
          <address type="work">
            <street_address></street_address>
            <city></city>
            <state></state>
            <zip></zip>
            <country code=""> </country>
            <line_1></line_1>
            <line_2></line_2>
          </address>
          <address type="other">
            <street_address></street_address>
            <city></city>
            <state></state>
            <zip></zip>
            <country code=""> </country>
            <line_1></line_1>
            <line_2></line_2>
          </address>
        </addresses>
        <phones>
          <phone type="home"></phone>
          <phone type="work"></phone>
          <phone type="mobile"></phone>
        </phones>
        <mobile_carrier id="0"> </mobile_carrier>
        <gender>M</gender>
        <marital_status></marital_status>
        <birthday>1966-02-12</birthday>
        <anniversary></anniversary>
        <baptized>false</baptized>
        <deceased></deceased>
        <membership_type id=""> </membership_type>
        <membership_date></membership_date>
        <membership_end></membership_end>
        <receive_email_from_church>true</receive_email_from_church>
        <default_new_group_messages>Group Default</default_new_group_messages>
        <default_new_group_comments>Group Default</default_new_group_comments>
        <default_new_group_digest>Group Default</default_new_group_digest>
        <default_new_group_sms>Never</default_new_group_sms>
        <privacy_settings>
          <profile_listed>true</profile_listed>
          <mailing_address id="2">My Friends</mailing_address>
          <home_address id="2">My Friends</home_address>
          <home_phone id="3">My Friends and Group Members</home_phone>
          <work_phone id="2">My Friends</work_phone>
          <mobile_phone id="2">My Friends</mobile_phone>
          <emergency_phone id="2">My Friends</emergency_phone>
          <birthday id="4">Everyone</birthday>
          <anniversary id="4">Everyone</anniversary>
          <gender id="4">Everyone</gender>
          <marital_status id="2">My Friends</marital_status>
          <user_defined_fields id="2">My Friends</user_defined_fields>
          <allergies id="1">Church Leadership</allergies>
        </privacy_settings>
        <active>true</active>
        <creator id="0">System User</creator>
        <modifier id="0">System User</modifier>
        <created>2014-01-28 14:24:17</created>
        <modified>2014-01-28 14:24:17</modified>
        <user_defined_text_fields/>
        <user_defined_date_fields/>
        <user_defined_pulldown_fields/>
      </individual>
    </individuals>
  </response>
</ccb_api>
```

--------------------------------

### Create Event Response XML

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example of the XML response structure returned after a successful event creation.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="create_event" name="srv"/>
    </parameters>
  </request>
  <response>
    <service>create_event</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <event id="12">
      <name>Test Event via API</name>
      <description></description>
      <leader_notes></leader_notes>
      <start_datetime>2012-09-27 09:00:00</start_datetime>
      <start_date>Sep 27, 2012</start_date>
      <start_time>9:00 AM</start_time>
      <end_datetime>2012-09-27 11:30:00</end_datetime>
      <end_date>Sep 27, 2012</end_date>
      <end_time>11:30 AM</end_time>
      <timezone>America/Denver</timezone>
      <recurrence_description>Every month on the second Tuesday of the month from 9:00 AM to 11:30 AM</recurrence_description>
      <exceptions/>
      <group id="1">Entire Church Group</group>
      <organizer id="1">Larry Cucumber</organizer>
      <phone type="mobile"></phone>
      <location/>
      <registration>
        <limit>0</limit>
        <event_type id="1">Open to All</event_type>
        <forms/>
      </registration>
      <resources/>
      <setup>
        <start>2012-09-27 09:00:00</start>
        <end>2012-09-27 11:30:00</end>
        <notes></notes>
      </setup>
      <event_grouping id=""></event_grouping>
      <creator id="0">System User</creator>
      <modifier id="0">System User</modifier>
      <created>2014-01-28 14:17:50</created>
      <modified>2014-01-28 14:17:50</modified>
    </event>
  </response>
</ccb_api>
```

--------------------------------

### Import Batches via Curl

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Use this curl command to upload an XML file for batch creation.

```bash
curl -u user:password -F filedata=@your_local_file_location "http://your_test_site/api.php?srv=import_batches"
```

--------------------------------

### Create Event via Curl

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example of using a curl command to create an event via an HTTP POST request.

```bash
  curl -u user:pass -d "name=Test+Event+via+API&start_date=2012-09-27+09:00:00&end_date=2012-09-27+11:30:00&group_id=1&recurrence_type=monthly&recurrence_week_number=second&recurrence_day_of_week=tue" "https://yourchurch.ccbchurch.com/api.php?srv=create_event"
```

--------------------------------

### Manage Group Leaders XML Example

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

This XML structure demonstrates how to send a request to manage group leaders, specifying the service and group ID.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="manage_group_leaders" name="srv"/>
      <argument value="13" name="group_id"/>
      <argument value="" name="leader_ids"/>
    </parameters>
  </request>
  <response>
    <service>manage_group_leaders</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <group id="13">
      <name>Fours</name>
      <leaders>
        <leader id="1">
          <name>Jacki Clark</name>
        </leader>
        <leader id="2">
          <name>Carol Darling</name>
        </leader>
        <leader id="1018">
          <name>Dakota Pyle</name>
        </leader>
      </leaders>
    </group>
  </response>
</ccb_api>
```

--------------------------------

### Example XML for Group Participants

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

This XML response shows the structure of data returned when querying for group participants, including participant details.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="group_participants" name="srv"/>
      <argument value="23" name="id"/>
    </parameters>
  </request>
  <response>
    <service>group_participants</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <groups count="1">
      <group id="23" name="**Ninja Turtle Club**">
        <participants count="10">
          <participant id="1">
            <name>Larry Cucumber</name>
            <email>test@test.com</email>
            <mobile_phone></mobile_phone>
            <carrier id="0"></carrier>
            <receive_email_from_church>true</receive_email_from_church>
            <receive_email_from_group>true</receive_email_from_group>
            <receive_sms_from_group>false</receive_sms_from_group>
            <status id="2">Member</status>
            <date_joined>2012-09-20 08:51:01</date_joined>
            <active>true</active>
            <creator id="1">Larry Cucumber</creator>
            <modifier id="1">Larry Cucumber</modifier>
            <created>2012-09-20 08:51:01</created>
            <modified>2012-09-25 15:46:15</modified>
            <first_name>Larry</first_name>
            <last_name>Cucumber</last_name>
            <middle_name></middle_name>
            <legal_first_name></legal_first_name>
            <salutation>Mr.</salutation>
            <suffix></suffix>
          </participant>
          …
          <participant id="61">
            <name>Bob Tom</name>
            <email></email>
            <mobile_phone></mobile_phone>
            <carrier id="0"></carrier>
            <receive_email_from_church>true</receive_email_from_church>
            <receive_email_from_group>true</receive_email_from_group>
            <receive_sms_from_group>false</receive_sms_from_group>
            <status id="2">Member</status>
            <date_joined>2013-04-08 06:51:45</date_joined>
            <active>true</active>
            <creator id="1">Larry Cucumber</creator>
            <modifier id="1">Larry Cucumber</modifier>
            <created>2013-04-08 06:51:45</created>
            <modified>2013-04-08 06:51:45</modified>
          </participant>
        </participants>
      </group>
    </groups>
  </response>
</ccb_api>
```

--------------------------------

### Individual Search API Request Example

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

This cURL command demonstrates how to use the individual_search service to find individuals by last name. Ensure you replace 'user:pass' with your actual credentials and 'yourchurch.ccbchurch.com' with your CCB domain.

```bash
curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=individual_search&last_name=Bob"
```

--------------------------------

### GET campus_list

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Retrieves a list of all campuses available in the system.

```APIDOC
## GET campus_list

### Description
The Campus List service returns a list of campuses.

### Method
GET

### Endpoint
https://yourchurch.ccbchurch.com/api.php?srv=campus_list

### Response
#### Success Response (200)
- **campuses** (object) - A collection of campus items containing id, name, active status, and creator information.

#### Response Example
<ccb_api>
  <response>
    <campuses count="9">
      <campus id="1">
        <name>Church of Cucumbers</name>
        <active>1</active>
      </campus>
    </campuses>
  </response>
</ccb_api>
```

--------------------------------

### GET campus_profile

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Retrieves detailed information for a specific campus by its ID.

```APIDOC
## GET campus_profile

### Description
The Campus Profile service returns campus details for the ID provided.

### Method
GET

### Endpoint
https://yourchurch.ccbchurch.com/api.php?srv=campus_profile&id={id}

### Parameters
#### Query Parameters
- **id** (integer) - Required - The unique identifier of the campus.

### Response
#### Success Response (200)
- **campus** (object) - Detailed campus information including addresses, phones, and timezone.

#### Response Example
<ccb_api>
  <response>
    <campus id="1">
      <name>Church of Cucumbers</name>
      <timezone>America/Denver</timezone>
    </campus>
  </response>
</ccb_api>
```

--------------------------------

### Example Output XML for Import Batches

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

This XML represents the output of a successful 'import_batches' API request. It details the structure of batch and transaction data, including associated metadata like campus, individual, dates, and status.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
     <request>
          <parameters>
               <argument value="import_batches" name="srv"/>
          </parameters>
     </request>
     <response>
          <service>import_batches</service>
          <service_action>execute</service_action>
          <availability>public</availability>
          <batches count="1">
               <batch id="1410">
                    <campus id="1">User Experience Campus</campus>
                    <post_date>2013-11-12</post_date>
                    <begin_date>2016-03-04</begin_date>
                    <end_date>2016-03-04</end_date>
                    <in_accounting_package>false</in_accounting_package>
                    <status>Closed</status>
                    <source>Created through API</source>
                    <transactions>
                         <transaction id="2815">
                              <campus id="1">User Experience Campus</campus>
                              <individual id="48">Amy Arnold</individual>
                              <date>2006-05-04</date>
                              <grouping id="1">3rd</grouping>
                              <payment_type>Cash</payment_type>
                              <check_number></check_number>
                              <transaction_details>
                                   <transaction_detail id="3271">
                                        <coa id="1">Other</coa>
                                        <amount>250.32</amount>
                                        <tax_deductible>true</tax_deductible>
                                        <note>note0</note>
                                        <creator id="0">System User</creator>
                                        <modifier id="0">System User</modifier>
                                        <created>2016-03-04 01:25:04</created>
                                        <modified>2016-03-04 01:25:04</modified>
                                   </transaction_detail>
                                   <transaction_detail id="3272">
                                        <coa id="2">Benevolence</coa>
                                        <amount>10.35</amount>
                                        <tax_deductible>true</tax_deductible>
                                        <note></note>
                                        <creator id="0">System User</creator>
                                        <modifier id="0">System User</modifier>
                                        <created>2016-03-04 01:25:04</created>
                                        <modified>2016-03-04 01:25:04</modified>
                                   </transaction_detail>
                              </transaction_details>
                              <creator id="0">System User</creator>
                              <modifier id="0">System User</modifier>
                              <created>2016-03-04 01:25:04</created>
                              <modified>2016-03-04 01:25:04</modified>
                         </transaction>
                         <transaction id="2816">
                              <campus id="1">User Experience Campus</campus>
                              <individual id="50">Noell Arrington</individual>
                              <date>2006-05-04</date>
                              <grouping id=""></grouping>
                              <payment_type>Check</payment_type>
                              <check_number>1234</check_number>
                              <transaction_details>
                                   <transaction_detail id="3273">
                                        <coa id="2">Benevolence</coa>
                                        <amount>10</amount>
                                        <tax_deductible>true</tax_deductible>
                                        <note></note>
                                        <creator id="0">System User</creator>
                                        <modifier id="0">System User</modifier>
                                        <created>2016-03-04 01:25:04</created>
                                        <modified>2016-03-04 01:25:04</modified>
                                   </transaction_detail>
                              </transaction_details>
                              <creator id="0">System User</creator>
                              <modifier id="0">System User</modifier>
                              <created>2016-03-04 01:25:04</created>
                              <modified>2016-03-04 01:25:04</modified>
                         </transaction>
                    </transactions>
                    <creator id="0">System User</creator>
                    <modifier id="0">System User</modifier>
                    <created>2016-03-04 01:25:04</created>
                    <modified>2016-03-04 01:25:04</modified>
               </batch>
          </batches>
     </response>
</ccb_api>
```

--------------------------------

### Individual Attendance Service Requests and Responses

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Examples for the individual_attendance service using cURL and XML.

```bash
  curl -u user:pass -d "" "https://yourchurch.ccbchurch.com/api.php?srv=individual_attendance&individual_id=48"
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="individual_attendance" name="srv"/>
      <argument value="48" name="individual_id"/>
    </parameters>
  </request>
  <response>
    <service>individual_attendance</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <individuals count="1">
      <individual id="48">
        <name>Little Joe</name>
        <attendances>
          <attendance>
            <event id="776">Sunday School</event>
            <group id="1">Entire Church Group</group>
            <occurrence>2012-06-17 09:00:00</occurrence>
          </attendance>
          …
          <attendance>
            <event id="1806">Kids Club!</event>
            <group id="1">Entire Church Group</group>
            <occurrence>2013-10-17 09:00:00</occurrence>
          </attendance>
        </attendances>
      </individual>
    </individuals>
  </response>
</ccb_api>
```

--------------------------------

### GET attendance_profiles

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Retrieves attendance data for a specified date range.

```APIDOC
## GET attendance_profiles

### Description
Returns attendance data for events within a specified date range.

### Method
GET

### Endpoint
/api.php?srv=attendance_profiles

### Parameters
#### Query Parameters
- **start_date** (datetime) - Required - The start of the date range.
- **end_date** (datetime) - Required - The end of the date range.
```

--------------------------------

### Fetch Saved Searches (XML)

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Example XML for requesting and receiving a list of saved searches. The response includes details like search ID, name, and creator.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="search_list" name="srv"/>
    </parameters>
  </request>
  <response>
    <service>search_list</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <searches count="6">
      <search id="106">
        <name>Indiv. Created in Last Month</name>
        <last_run>2010-09-04 08:14:34</last_run>
        <listed>1</listed>
        <creator id="1">Larry Cucumber</creator>
        <modifier id="1">Larry Cucumber</modifier>
        <created>2005-05-24 17:04:25</created>
        <modified>2010-09-04 08:14:34</modified>
				<search_id>106</search_id>
      </search>
      …
      <search id="117">
        <name>Larry!!!</name>
        <last_run>2012-11-21 10:56:17</last_run>
        <listed>1</listed>
        <creator id="1">Larry Cucumber</creator>
        <modifier id="1">Larry Cucumber</modifier>
        <created>2012-11-21 10:56:17</created>
        <modified>2012-11-21 10:56:17</modified>
				<search_id>117</search_id>
      </search>
    </searches>
  </response>
</ccb_api>
```

--------------------------------

### GET attendance_profile

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Retrieves attendance information for a specific occurrence of an event.

```APIDOC
## GET attendance_profile

### Description
Retrieves attendance information for a provided occurrence of an event.

### Method
GET

### Endpoint
/api.php?srv=attendance_profile

### Parameters
#### Query Parameters
- **id** (integer) - Required - The ID of the event.
- **occurrence** (datetime) - Required - The date of the event occurrence.

### Response
#### Success Response (200)
- **event** (object) - Contains event details including name, occurrence, and list of attendees.
```

--------------------------------

### GET transactions_by_family

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Retrieves transaction records associated with a specific family.

```APIDOC
## GET transactions_by_family

### Description
Retrieves transaction records for a specific family, with optional date filtering.

### Method
GET

### Endpoint
https://yourchurch.ccbchurch.com/api.php?srv=transactions_by_family

### Parameters
#### Query Parameters
- **srv** (string) - Required - The service name: transactions_by_family
- **family_id** (integer) - Required - The ID of the family.
- **date_start** (datetime) - Optional - Start date for filtering transactions.
- **date_end** (datetime) - Optional - End date for filtering transactions.
- **modified_since** (datetime) - Optional - Filter transactions modified since this date.
```

--------------------------------

### POST create_individual

Source: https://designccb.s3.amazonaws.com/helpdesk/files/official_docs/api.html

Creates a new individual and family profile in the system.

```APIDOC
## POST create_individual

### Description
The Create Individual service accepts form-encoded data to create a new individual and family in the Pushpay system.

### Method
POST

### Endpoint
https://yourchurch.ccbchurch.com/api.php?srv=create_individual

### Parameters
#### Request Body
- **first_name** (string) - Required - The first name of the individual
- **last_name** (string) - Required - The last name of the individual
```