The Forms API

Introduction

The Forms API is used to gather details about the forms you have permission to access. This API can be used to create a list of all forms belonging to a user and dynamically generate a form embed snippet to use in your application. You can see a call to this API in action here:

If you are unsure how to get started with our APIs, please read our introduction for information on authenticating, sending and processing your API requests.

Request Format

This API accepts GET requests in the following two formats:

https://{subdomain}.wufoo.com/api/v3/forms.{xml|json}[?pretty=true]&[includeTodayCount=false]

and

https://{subdomain}.wufoo.com/api/v3/forms/{formIdentifier}.{xml|json}[?pretty=true]&[IncludeTodayCount=false]

The expected parameters for this request are:

• {subdomain} - This must be replaced with your Wufoo account subdomain.

• {xml|json} - Choose xml or json as your output type.

• {formIdentifier} - Adding the {formIdentifier} will give you information about just one form. The call without the {formIdentifier} will return all forms.

• {?pretty=true} - The optional pretty=true get parameter formats your output as HTML for debugging through the browser.

• {IncludeTodayCount} - Will give you today’s entry count for the form.

Sample Response

Below is a sample response from a fictional call to the Forms API.

<Form>
    <Name>All Integrations</Name>
    <Description>This is my form. Please fill it out. It's awesome!</Description>
    <RedirectMessage>Success! Thanks for filling out my form!</RedirectMessage>
    <Url>all-integrations</Url>
    <Email/>
    <IsPublic>1</IsPublic>
    <Language>english</Language>
    <StartDate>2000-01-01 12:00:00</StartDate>
    <EndDate>2030-01-01 12:00:00</EndDate>
    <EntryLimit>0</EntryLimit>
    <DateCreated>2010-01-18 10:00:50</DateCreated>
    <DateUpdated>2010-01-18 10:00:50</DateUpdated>
    <Hash>z7x3w1</Hash>
</Form>

The <Form> Element

The <Form> element lives inside the parent. One <Form> element exists for each form on your system. So, if you have 5 forms in your account and you’re permitted to see them all, you’ll have 5 <Form> elements in the return value from your API call.

Values for the <Form> element are defined below.

• Name - The title of the form specified in the Form Settings.

• Description - The description of the form as specified in the Form Settings.

• Redirect Message - The confirmation message shown to users after they have successfully filled out the form.

• Url - This is the user friendly URL hash used for the form. Beware of using this URL parameter for API or linking purposes because it changes when the form title is changed. Use the Hash parameter when you need a permanent URL link.

• Email - A list of comma-separated email addresses that are setup to accept notification emails when the form collects new entries.

• IsPublic - Indicates whether or not the form is visible to user. Possible values are binary (1 = true, 0 = false).

• Language - Indicates the language set for this account in the Form Settings.

• StartDate - The date/time the form will be accessible through the public URL.

• EndDate - The date/time the form will no longer be accessible through the public URL.

• EntryLimit - The maximum number of entries this form will accept before it is no longer accessible through the public URL.

• DateCreated - A timestamp of when the form was created.

• DateUpdated - A timestamp of when the form was lasted edited in the Wufoo Form Builder.

• Hash - An unchanging hashed value unique to this form on this user’s account.

• EntryCountToday - Returns a count of the number of entries received today. By default, this value is not given with the form request. This value requires a request through the IncludeTodayCount GET parameter because it is a bit more intensive to pull from our database servers. Please only request this parameter if you’re actually using the number.

• LinkFields - Convenient link to the Fields API to pull the list of fields associated with this form.

• LinkEntries - Convenient link to the Entries API to pull the list of entries associated with this form.

• LinkEntriesCount - Convenient link to the Entries API to pull the number of entries collected by this form.