Home → FormSpring API → Methods → forms

2.1. forms

This method returns a list of forms in an account. The response includes all of the information returned by the form method, with the exception of information about each form field and the HTML or JavaScript required to display the form.

Authentication

This method requires an API key with info, data or write permissions. The response will only list forms that the API key has access to.

Arguments

• api_key (required)

Example Request

https://www.formspring.com/api/forms?api_key=ABCDE&type=xml

Response

• forms - array containing one entry per form
  • id - form id
  • name - form name
  • views - the number of times the form has been viewed
  • submissions - the number of submissions stored for the form
  • created - the date the form was created in YYYY-MM-DD HH:MM:SS format
  • last_submission_id - the id of the latest submission
  • last_submission_time - the timestamp of the latest submission in YYYY-MM-DD HH:MM:SS format
  • url - public url for the form
  • data_url - share data url with full data access (only supplied if the API key has data access)
  • summary_url - share data url with summary access (only supplied if the API key has data access)
  • rss_url - url to the rss feed for data (only supplied if the API key has data access)

Example XML Response:

<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<forms>
<form>
<id>1001</id>
<name>Test Form 1</name>
<views>100</views>
<created>2007-01-01 23:59:59</created>
<submissions>100</submissions>
<last_submission_id>1111</last_submission_id>
<last_submission_time>2007-01-02 23:59:59</last_submission_time>
<url>https://www.formspring.com/admin/data.php?1111A</url>
<data_url>https://www.formspring.com/admin/data.php?1111B</data_url>
<summary_url>https://www.formspring.com/admin/data.php?1111C</summary_url>
<rss_url>https://www.formspring.com/admin/rss.php?1111D</rss_url>
</form>
<form>
<id>1002</id>
<name>Test Form 2</name>
<views>100</views>
<created>2007-02-01 23:59:59</created>
<submissions>100</submissions>
<last_submission_id>2222</last_submission_id>
<last_submission_time>2007-02-02 23:59:59</last_submission_time>
<url>https://www.formspring.com/admin/data.php?2222A</url>
<data_url>https://www.formspring.com/admin/data.php?2222B</data_url>
<summary_url>https://www.formspring.com/admin/data.php?2222C</summary_url>
<rss_url>https://www.formspring.com/admin/rss.php?2222D</rss_url>
</form>
</forms>
</response>

Example JSON Response:

{
"status" : "ok",
"response" : {
"forms" : [ {
"id" : "1001",
"name" : "Test Form 1",
"views" : "100",
"created" : "2007-01-01 23:59:59",
"submissions" : 100,
"last_submission_id" : "1111",
"last_submission_time" : "2007-01-02 23:59:59",
"url" : "https://www.formspring.com/admin/data.php?1111A",
"data_url" : "https://www.formspring.com/admin/data.php?1111B",
"summary_url" : "https://www.formspring.com/admin/data.php?1111C",
"rss_url" : "https://www.formspring.com/admin/rss.php?1111D"
}, {
"id" : "1002",
"name" : "Test Form 2",
"views" : "100",
"created" : "2007-02-01 23:59:59",
"submissions" : 100,
"last_submission_id" : "2222",
"last_submission_time" : "2007-02-02 23:59:59",
"url" : "https://www.formspring.com/admin/data.php?2222A",
"data_url" : "https://www.formspring.com/admin/data.php?2222B",
"summary_url" : "https://www.formspring.com/admin/data.php?2222C",
"rss_url" : "https://www.formspring.com/admin/rss.php?2222D"
} ]
}
}

Example PHP Response:

a:2:{s:6:"status";s:2:"ok";s:8:"response";a:1:{s:5:"forms";a:2:{i:0;a:11:{s:2:"id";s:4:"1001";s:4:"name";s:11:"Test Form 1";s:5:"views";s:3:"100";s:7:"created";s:19:"2007-01-01 23:59:59";s:11:"submissions";i:100;s:18:"last_submission_id";s:4:"1111";s:20:"last_submission_time";s:19:"2007-01-02 23:59:59";s:3:"url";s:47:"https://www.formspring.com/admin/data.php?1111A";s:8:"data_url";s:47:"https://www.formspring.com/admin/data.php?1111B";s:11:"summary_url";s:47:"https://www.formspring.com/admin/data.php?1111C";s:7:"rss_url";s:46:"https://www.formspring.com/admin/rss.php?1111D";}i:1;a:11:{s:2:"id";s:4:"1002";s:4:"name";s:11:"Test Form 2";s:5:"views";s:3:"100";s:7:"created";s:19:"2007-02-01 23:59:59";s:11:"submissions";i:100;s:18:"last_submission_id";s:4:"2222";s:20:"last_submission_time";s:19:"2007-02-02 23:59:59";s:3:"url";s:47:"https://www.formspring.com/admin/data.php?2222A";s:8:"data_url";s:47:"https://www.formspring.com/admin/data.php?2222B";s:11:"summary_url";s:47:"https://www.formspring.com/admin/data.php?2222C";s:7:"rss_url";s:46:"https://www.formspring.com/admin/rss.php?2222D";}}}}