Form List

The Form List service returns a listing of all forms defined in the Pushpay system, along with the web addresses to access them.

Service Name

form_list

Required Parameters

None

Optional Parameters

NameType
form_idinteger
campus_idinteger
modified_sincestring[20]
include_archivedboolean

Example Curl

curl -u user:pass "https://yourchurch.ccbchurch.com/api.php?srv=form_list&form_id=1"

Example Response XML

<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
  <request>
    <parameters>
      <argument value="form_list" name="srv"/>
      <argument value="1" name="form_id"/>
    </parameters>
  </request>
  <response>
    <service>form_list</service>
    <service_action>execute</service_action>
    <availability>public</availability>
    <items count="3">
      <form id="1">
      <title>Erin's Form</title>
      <description></description>
      <campus id="1">User's Experience Campus</campus>
      <managers>
        <manager id="1">Larry Boy</manager>
        <manager id="2424">Basic User</manager>
        <manager id="2421">Limited Financial</manager>
      </managers>
      <start>2013-08-15</start>
      <end></end>
      <public>false</public>
      <published>true</published>
      <status>Available</status>
      <creator id="1">Larry Boy</creator>
      <modifier id="1">Larry Boy</modifier>
      <created>2013-02-14 14:10:25</created>
      <modified>2013-08-15 16:28:02</modified>
      <url>https://yourchurch.ccbchurch.com/form_response.php?id=1</url>
      </form>
    </items>
  </response>
</ccb_api>