Example code for interacting with FormAssembly.com's OAuth2 API endpoints. Examples currently include PHP, Python, Bash, Salesforce.
PHP Shell JavaScript Python
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

The FormAssembly API

Introduction

FormAssembly.com is a web-based form management solution that allows anyone to easily create online forms and collect data. FormAssembly is available in different flavors, cloud-hosted (SaaS) or on-premises, and all editions provide a secure REST API for interacting with user accounts and exporting data.

Before you can start building an application using the FormAssembly API, check out the FormAssembly Developer Hub for information on how to register, obtain a CLIENT_ID, and get access to a sandbox.


Endpoint

The endpoint, in API parlance, is the destination URL for your API requests. The endpoint will vary depending on the FormAssembly edition you're interacting with.

Edition Endpoint Note
FormAssembly Developer Sandbox https://developer.formassembly.com/api_v1/ For development and testing only
FormAssembly.com https://app.formassembly.com/api_v1/
FormAssembly Enterprise Cloud https://instance_name.tfaforms.net/api_v1/ Adjust instance_name as needed
FormAssembly Enterprise On-Site https://your_server/path/to/formassembly/api_v1/ Adjust your_server and path as needed

From this point on, we'll use the FormAssembly.com endpoint. Just remember to adjust the URIs to match your own FormAssembly edition.


Registration

Before you can interact with the API, you must obtain a CLIENT_ID and a CLIENT_SECRET code. This is done by completing the registration process on the particular instance you are targeting. For the Developer Sandbox and FormAssembly.com, you must register through the FormAssembly Developer Hub. For Enterprise instances, the FormAssembly administrator can register your app.


Authorization

Authorization is the mechanism that lets FormAssembly users decide which applications can access their account through the API. Authorizations are handled using the OAuth2 protocol.

If you're not familiar with OAuth2 interactions, it can be helpful to look at the documentation of other APIs, such as this one for the Google API, explaining how OAuth2 works in detail.

The key point of OAuth2 is that it allows a user of FormAssembly (let's call them Adam), to authorize a client (you) to take actions in FormAssembly as if you were Adam. For example, you could write an application, which when authorized by Adam, could download and display a list of all of Adam's forms along with associated metrics, e.g., number of responses, dropout rates, etc. This data could then be used by you to generate custom reports for Adam.


Step-by-Step Outline

To request a user's authorization, your application must follow these steps.

1. Redirect the User to the Authorization URL

https://app.formassembly.com/oauth/login?type=web&client_id=CLIENT_ID&redirect_uri=RETURN_URL&response_type=code

  • CLIENT_ID: The unique client ID generated by FormAssembly for your client application (see Registration above).
  • RETURN_URL: The URL that your user will be returned to when they complete the authorization step on FormAssembly. This value must be URL-encoded.

2. Retrieve the Authorization Code

FormAssembly will append the code query string parameter to your RETURN_URL when returning the user to the URL. For instance, redirect_uri=https%3A%2F%2Fwww.yourapp.com (note that the value is URL-encoded) will result in the user being taken to https://www.yourapp.com?code=XXXXXXXXXX after authorizing FormAssembly.

Retrieve the code from the query string. You will need it to obtain the access token.

3. Request an Access Token

Execute a HTTP request from your server (do not direct the user) to request an access token.

Parameter Name Value Comment
grant_type authorization_code Use this value as-is
type web_server Use this value as-is
client_id CLIENT_ID Use your unique client application ID issued by FormAssembly
client_secret CLIENT_SECRET Use your unique client application secret issued by FormAssembly
redirect_uri RETURN_URL The same RETURN_URL used in Step 1
code CODE The code parameter you obtained in Step 2

The response to this request will be a JSON array, like so:

{ "access_token":"XXXXXXXXXXXXXX",
  "expires_in":XXXXX,
  "scope":XXXX,
  "refresh_token":"XXXXXXXXXXXX" }

Store the access_token value. You'll need it for every API request on the user account. Since the access token is valid for only one user account, you will typically obtain multiple access_token from multiple users, and you must store and manage those tokens accordingly.

The refresh_token is used in a similar way to other OAuth2 implementations - it's used to obtain a renewed access token. Expiration time for access tokens is set to 10 years. Here is a bit more documentation on refresh tokens.


Example

Request

A HTTP GET request to:

https://app.formassembly.com/api_v1/forms/index.json?access_token=ACCESS_TOKEN

The URL is composed of the following parts:

  • https://app.formassembly.com/: The FormAssembly instance.
  • api_v1: The API version in use. As changes are made to the API, new versions can be released (e.g., under api_v2, api_v3, etc.).
  • forms/index: The requested data (see API Reference below).
  • json: The requested format for the response.
  • ACCESS_TOKEN: The token received in Step 3 of the authorization process.

Response

The response from the request above will result in a JSON-formatted list of the forms in the user's account:

{"Forms":[{
"Form":{
"id":"XXXX", "version_id":"XXXX", "name":"XXXXXXXX",
"category":"XXXX", "subcategory":"XXXX", "is_template":"XXXX",
"display_status":"XXXX", "moderation_status":"XXXX", "expired":"XXXX",
"use_ssl":"XXXX", "user_id":"XXXX",
"created":"XXXXXXXX", "modified":"XXXXXXXX",
"Aggregate_metadata":{
"id":"XXXX", "response_count":"XXXX", "submitted_count":"XXXX",
"saved_count":"XXXX", "unread_count":"XXXX", "dropout_rate":"XXXX",
"average_completion_time":"XXXX", "is_uptodate":"XXXX"
    }}
}]}

For an explanation of each field, please see Object Reference.

Several output formats are accepted. See Formats for more details.


API Reference

Formats

FormAssembly supports returning data in two main formats:

  • json: A lightweight data exchange format supported by newer languages. Directly parsable by JavaScript.
  • xml: An industry standard data exchange format, parsable by almost all languages.

Some endpoints support additional formats, including:


Forms [Returned Fields Reference]

Admin Index (Enterprise Plan only)

Returns a list of all forms in the FormAssembly instance. Only accessible if using FormAssembly Enterprise and an access token from an admin-level user.

Index

Returns a list of the forms in the user's account, along with associated metadata.

View
Additional Parameters
  • raw: Bypass form XML element whitelisting.

Return an encoded copy of the form's definition in XML or JSON. Raw parameter will cause the returned output to be exactly the content stored by FormAssembly including obsolete or internal fields. Generally you should not use the raw parameter.

Create
Additional Parameters (POST only)
  • xml_data: xml data formatted per FormAssembly's schema. See output of api_v1/forms/view.
  • builder_version: string identifier, e.g. "3.4.2","4.0.0","4.0.1","4.1.0","4.2.0".
  • language: iso language code, e.g. "en-US","fr","zh-CN"
  • name: string text of the preferred internal application display name.

Create a new form. Expects the additional parameters listed above to be sent as POST.

Edit
Additional Parameters (POST only)
  • id: id for existing form.
  • xml_data: xml data formatted per FormAssembly's schema. See output of api_v1/forms/view.
  • builder_version: string identifier, e.g. "3.4.2","4.0.0","4.0.1","4.1.0","4.2.0".
  • language: iso language code, e.g. "en-US","fr","zh-CN"
  • name: string text of the preferred internal application display name.

Send update to form code. Expects the additional parameters listed above to be sent as POST.

Delete
Additional Parameters (POST only)
  • id: id for existing form.

Delete form. Expects the additional parameters listed above to be sent as POST.

Code Examples

Responses [Returned Fields Reference]

Export
Additional Parameters
  • date_from: Start date for export range.
  • date_to: End date for export range.
  • filter: If set to all, export will include both completed and incomplete responses.
  • response_ids: Set of comma-delimited response IDs to retrieve.
Examples

Connectors

Index

Returns a list of the connectors associated with form #FORMID#.

View

Return an encoded copy of the connectors's definition in XML or JSON. #CONNECTORID# can be retrieved from the api_v1/connectors/index/#FORMID# call.

Create
Additional Parameters (POST only)
  • event: string, indicating the stage the connector is run: "beforerender" - before form is displayed to user,"before_save" - when form is saved by user, "interactive" - after form is completed, "background" - after user is shown the form's thank-you page.

Create a new connector. Expects the additional parameters listed above to be sent as POST. #CONNECTORID# can be retrieved from the api_v1/connectors/index/#FORMID# call.

Edit
Additional Parameters (POST only)
  • mapping: data to set as connector mapping.
  • login: login data for the connector service.
  • password: password data for the connector service.

Send update to connector code. Expects the additional parameters listed above to be sent as POST.

Delete

Delete connector.


Themes

Index

Returns a list of the themes associated user account.

View

Return the theme's definition in raw CSS. #THEMEID# can be retrieved from the api_v1/themes/index/#FORMID# call. Note this data may contain links to local urls that will not match a new environment.

Create
Additional Parameters (POST only)
  • name: string, indicating name of theme
  • css_data : string, CSS payload for the theme

Create a new theme. Expects the additional parameters listed above to be sent as POST.

Edit
Additional Parameters (POST only)
  • id: int, id of theme to be edited.
  • name: string, indicating name of theme
  • css_data : string, CSS payload for the theme

Send update to theme code. Expects the additional parameters listed above to be sent as POST.

Delete

Delete the theme.


Form Elements ( in flux, may change without warning )

Index

Returns a list of the form elements available to the user.

View

Return an XML copy of the element's definition in raw CSS. #ELEMENTID# can be retrieved from the api_v1/form_elements/index.xml call. Note this data may contain links to local urls that will not match a new environment.

Create
Additional Parameters (POST only)
  • xml_data: string, XML payload for FormAssembly FormBuilder
  • name : string, name for element
  • comments : string, TBD
  • category : string, system level category, (leave blank by default)
  • subcategory : string, user defined category
  • batch : int, TBD - leave blank

Create a new form element. Expects the additional parameters listed above to be sent as POST.

Edit
Additional Parameters (POST only)
  • id: int, id of element to be edited.
  • xml_data: string, XML payload for FormAssembly FormBuilder
  • name : string, name for element
  • comments : string, TBD
  • category : string, system level category, (leave blank by default)
  • subcategory : string, user defined category
  • batch : int, TBD - leave blank

Send update to element code. Expects the additional parameters listed above to be sent as POST.

Delete

Delete the element.


Aggregates

Reset_counters

Trigger a reset of the aggregate data counters (unread, read, saved, etc.) that may be out of sync after import runs.


Object Reference

Form
Object Description Example
"id":"XXXX" Unique integer value identifying the form within the FormAssembly instance. Every form has a single unique ID in the form of an integer. Can be used to construct a valid form URL, e.g., http://app.formassembly.com/forms/view/XXXX 1
"version_id":"XXXX" Unique integer ID identifying the current version (revision) of the form. 1
"name":"XXXXXXXX" HTML-encoded string representing the form's name as displayed in the user's FormAssembly form index list. Not to be confused with the Form Title, found in the form's XML definition. "Mine & Yours Form"
"category":"XXXX", String representing one of the system-wide default form organizational categories. Can be an empty string for uncategorized forms. "Contact Forms"
"subcategory":"XXXX", String representing one of the user-created organizational categories. Can be an empty string for uncategorized forms. "IBM Contact Forms"
"is_template":"XXXX", Integer specifying whether or not the form is shared as a template publicly. Contact Support for more details.

Values
0: Not a template
>1: Is a template
0
"display_status":"XXXX", Integer specifying whether or not the form is active or archived.

Values
0: Archived
2: Active
2
"moderation_status":"XXXX", Integer specifying whether or not the form is moderated (under review for suspicious content).

Values
0: Not checked
2: Reviewed and approved
3: Reviewed and denied
0
"use_ssl":"XXXX", Integer representing if the form must be displayed over HTTPS. If true, form URL must contain https://.
"created":"XXXXXXXX" String timestamp representing the date the form was created. "created":"1983-01-01 23:59:59"
"modified":"XXXXXXXX" String timestamp representing the last time the form or any of its settings were modified. "modified":"2012-06-17 17:50:12"
"expired":"XXXX" String timestamp representing the date the form was marked for deletion, if any. "expired":null

Self-Register Your App on an Existing Enterprise Instance

If you are developing for an existing Enterprise instance, you will need to self-register your app by following the instructions below.

  1. Login to your Enterprise account as an admin.

  2. Navigate to the Admin Dashboard tab.

    Step1

  3. In the Admin Dashboard, navigate to Settings > Third Party Apps on the sidebar menu.

    Step2

  4. Click "Register a new application."

    Step3

  5. Pick a name for your new application, and take note of your OAuth credentials.

    Step4