Skip to main content

forms/all

Retrieves all live Forms records from within the platforms.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • order_by (optional - default null)

Example request:

http://[domain]/api/forms/all.xml?api_key=[api_key]
    &per_page=1&page=2&order_by=title

Example response:

<?xml version="1.0" encoding="utf-8"?>
<forms page="1" pages="1" per_page="10" total="2" order_by="">
    <form id="139">
        <title>Test form 1</title>
        <categories>
            <category id="20000" name="Category One"/>
        </categories>
        <channels>
            <web>
                http://mysite.co.uk/site/scripts/xforms_form.php?formID=139
            </web>
        </channels>
    </form>
    <form id="142">
        <title>Test form 2</title>
        <categories>
            <category id="20001" name="Category Two"/>
        </categories>
        <channels>
            <web>
                http://mysite.co.uk/site/scripts/xforms_form.php?formID=142
            </web>
        </channels>
    </form>
</forms>