Formstack
App · 20 actions
Manage forms, fields, submissions and folders with the current Formstack API.
Actions
| Action | What it does |
|---|---|
| Copy form | Create a copy of an existing form with optional configurations. |
| Count submissions | Counting form submissions. |
| Create field | Create a new field within the specified form. |
| Create form | Create a new form with optional fields. |
| Create submission | Create a new submission for the specified form. |
| Delete field | Permanently delete a field from the specified form. |
| Delete form | Soft delete a form (mark as deleted). |
| Delete submission | Permanently delete a submission and all associated data. |
| Get field | Retrieve detailed information about a specific field. |
| Get form | Retrieve detailed information about a specific form. |
| Get form html | Retrieve HTML markup for a specific form. |
| Get submission | Retrieve detailed information about a specific submission. |
| List fields | Retrieve all fields from a form. |
| List folders | Get all folders on your account and their subfolders. |
| List form submissions | Retrieve a paginated list of submissions for a specific form. |
| List forms | Retrieve a paginated list of forms with optional filtering and sorting. |
| Prefill form | Generate a prefilled form URL with specified field values. |
| Update field | Update an existing field within the specified form. |
| Update form | Update an existing form's properties. |
| Update submission | Update an existing submission with new data. |
Copy form
Create a copy of an existing form with optional configurations.
Inputs
- Form
form_idnumberRequired - Form id.
- Include integrations
include_integrationstrue/false - Flag to specify whether to copy integrationsDefault:
true. - Include emails
include_emailstrue/false - Flag to specify whether to copy emailsDefault:
true. - Template
templatenumber - Id of template to use when copying
- Folder
foldernumber - Id of folder where copy should be saved
Outputs
dataobject- Form details response
Example output
{
"data": {
"canEdit": false,
"created": "example",
"fields": [],
"folder": 1,
"formExtras": {
"fieldLabelsPosition": "example",
"language": "example",
"numberOfColumns": 1,
"showProgressIndicator": false,
"skipValidationBetweenPages": false,
"useCaptcha": false,
"useFieldPrefill": false,
"useOneQuestionAtATime": false,
"usePromptForLocation": false,
"useSaveAndResume": false,
"useSecurityLogo": false
},
"formSettings": {
"alias": "example",
"isActive": false,
"saveSubmissionsToDatabase": false,
"timezone": "example"
},
"hasApprovers": false,
"id": 1,
"isEncrypted": false,
"isWorkflowForm": false,
"isWorkflowPublished": false,
"name": "example",
"permissions": 1,
"submissionsCount": 1,
"submitButtonTitle": "example",
"todaySubmissionsCount": 1,
"unreadSubmissionsCount": 1,
"updated": "example",
"url": "example",
"version": 1,
"viewKey": "example"
}
}Count submissions
Counting form submissions.
Inputs
- Form
form_idnumberRequired - Form id.
- Start date
start_datedate and time - When to start submission count from.
- Lookback period
lookback_periodnumber - How many days to count backwards from (maximum is 7 days).
Outputs
dataobject- Form submission count response
Example output
{
"data": {
"totalSubmissions": 1,
"totalSubmissionsByDay": []
}
}Create field
Create a new field within the specified form.
Inputs
- Form
form_idnumberRequired - Form id.
- Label
labeltextRequired - Label of the field
- Type
typetextRequired - Type of the fieldOne of:
text,textarea,checkbox,radio,select,number,name,email,phone,address, and 11 more. - Internal label
internal_labeltext - Internal label of the field
- Supporting text
supporting_texttext - Description of the field
- Use callout
use_callouttrue/false - Flag to show the description in a callout boxDefault:
false. - Required
requiredtrue/false - Flag to mark field as requiredDefault:
false. - Read only
read_onlytrue/false - Flag to not allow the field to be changedDefault:
false. - Hidden
hiddentrue/false - Flag to hide the fieldDefault:
false. - Unique
uniquetrue/false - Flag to mark field as requiring a unique valueDefault:
false. - Hide label
hide_labeltrue/false - Flag to show or hide the labelDefault:
false. - Column span
column_spannumber - Determines how many columns this field takes on the live formDefault:
1. - Language
languagetext - Language of the fieldOne of:
default,af,sq,ar,bg,zh,zh-TW,hr,cs,da, and 27 more. Default:default. - Default value
default_valuetext - Default value of the field on the live form
- Options
optionslist - Options attached to field
- Smart list id
smart_list_idnumber - ID of smart list to attach
- Unlink smart list
unlink_smart_listtrue/false - Flag to unlink smart list from field
- Attributes
attributesobject - Field attributes component
- Logic
logicobject - Field logic conditions for conditional processing
- Numeric calculation
numeric_calculationobject - Numeric calculation definition for this field
- Datetime calculation
datetime_calculationobject - Datetime calculation definition for this field
Outputs
dataobject- Field details
Example output
{
"data": {
"attributes": {
"confirmationText": "example",
"hideInputCharacters": false,
"maxLength": 1,
"minLength": 1,
"placeholder": "example",
"removeDataFromEmailsAndExports": false,
"requireConfirmation": false,
"restrictDataAccess": false
},
"columnSpan": 1,
"datetimeCalculations": {
"calculationAllowNegatives": false,
"calculationOperator": "+",
"calculationType": "date",
"calculationUnits": "days",
"fieldOneCalculation": "example",
"fieldTwoCalculation": "example"
},
"defaultValue": "example",
"displayOrder": 1,
"hidden": false,
"hideLabel": false,
"id": 1,
"internalLabel": "example",
"label": "example",
"labelKey": "example",
"language": "example",
"logic": {
"action": "example",
"fields": [],
"operator": "example"
},
"numericCalculations": [],
"options": [],
"readOnly": false,
"required": false,
"smartListId": 1,
"supportingText": "example",
"type": "example",
"unique": false,
"useCallout": false
}
}Create form
Create a new form with optional fields.
Inputs
- Name
nametextRequired - Name of the form
- Template
templatenumber - ID of template of the form
- Stock template
stock_templatetext - Stock theme template code for the formOne of:
berryNice,blueAfterglow,calmZigZag,celadonParchment,clean,confetti,corporateOffice,dark,duskPop,formstack, and 7 more. Default:light. - Folder
foldernumber - ID of the folder where the form will be created
- Submit button title
submit_button_titletext - Title of submit button on live formDefault:
Submit Form. - Number of columns
number_of_columnsnumber - Number of visible columns in the formDefault:
1. - Field labels position
field_labels_positiontext - Position where field labels are placed on the live formOne of:
top,left. Default:top. - Save submissions to database
save_submissions_to_databasetrue/false - Flag to disable or enable submissions to be saved in our databaseDefault:
true. - Timezone
timezonetext - Timezone of the formOne of:
Pacific/Kwajalein,Pacific/Midway,Pacific/Honolulu,America/Anchorage,US/Pacific,US/Arizona,US/Mountain,US/Central,America/Mexico_City(America/mexico city),Canada/Saskatchewan, and 42 more. Default:US/Eastern. - Language
languagetext - Language of the formOne of:
af,sq,ar,bg,zh,zh-TW,hr,cs,da,nl, and 26 more. Default:en. - Is active
is_activetrue/false - Flag to make the form active/inactiveDefault:
true. - Disabled message
disabled_messagetext - The message to show when the form is inactive
- Fields
fieldslist - Optional fields to create with the form
Outputs
dataobject- Form details response
Example output
{
"data": {
"canEdit": false,
"created": "example",
"fields": [],
"folder": 1,
"formExtras": {
"fieldLabelsPosition": "example",
"language": "example",
"numberOfColumns": 1,
"showProgressIndicator": false,
"skipValidationBetweenPages": false,
"useCaptcha": false,
"useFieldPrefill": false,
"useOneQuestionAtATime": false,
"usePromptForLocation": false,
"useSaveAndResume": false,
"useSecurityLogo": false
},
"formSettings": {
"alias": "example",
"isActive": false,
"saveSubmissionsToDatabase": false,
"timezone": "example"
},
"hasApprovers": false,
"id": 1,
"isEncrypted": false,
"isWorkflowForm": false,
"isWorkflowPublished": false,
"name": "example",
"permissions": 1,
"submissionsCount": 1,
"submitButtonTitle": "example",
"todaySubmissionsCount": 1,
"unreadSubmissionsCount": 1,
"updated": "example",
"url": "example",
"version": 1,
"viewKey": "example"
}
}Create submission
Create a new submission for the specified form.
Inputs
- Form
form_idnumberRequired - Form id.
- Fields
fieldslist - Array of field data to be submitted with their values
- User agent
user_agenttext - The browser user agent string of the submitter
- Remote addr
remote_addrtext - The IP address from which the submission is being made
- Read
readtext - Whether to mark the submission as read upon creation (true/false)
- Longitude
longitudetext - The GPS longitude coordinate if location data is available
- Latitude
latitudetext - The GPS latitude coordinate if location data is available
- Device id
device_idtext - The unique device identifier if available from mobile submissions
- Field values
field_valuesobject - Fill in the form fields. Text values are converted to Formstack values automatically.
Outputs
dataobject- Response containing details of a newly created submission
Example output
{
"data": {
"data": [],
"formId": 1,
"id": 1,
"latitude": "example",
"longitude": "example",
"paymentStatus": "example",
"remoteAddr": "example",
"timestamp": "example",
"userAgent": "example"
}
}Delete field
Permanently delete a field from the specified form.
Inputs
- Form
form_idnumberRequired - Form id.
- Field id
field_idnumberRequired - Field id.
Outputs
dataobject- Field preview response
Example output
{
"data": {
"attributes": {
"confirmationText": "example",
"hideInputCharacters": false,
"maxLength": 1,
"minLength": 1,
"placeholder": "example",
"removeDataFromEmailsAndExports": false,
"requireConfirmation": false,
"restrictDataAccess": false
},
"columnSpan": 1,
"datetimeCalculations": {
"calculationAllowNegatives": false,
"calculationOperator": "+",
"calculationType": "date",
"calculationUnits": "days",
"fieldOneCalculation": "example",
"fieldTwoCalculation": "example"
},
"defaultValue": "example",
"displayOrder": 1,
"hidden": false,
"hideLabel": false,
"id": 1,
"internalLabel": "example",
"label": "example",
"labelKey": "example",
"language": "example",
"logic": {
"action": "example",
"fields": [],
"operator": "example"
},
"numericCalculations": [],
"options": [],
"readOnly": false,
"required": false,
"smartListId": 1,
"supportingText": "example",
"type": "example",
"unique": false,
"useCallout": false
}
}Delete form
Soft delete a form (mark as deleted).
Inputs
- Form
form_idnumberRequired - Form id.
Outputs
dataobject- Form preview response
Example output
{
"data": {
"active": false,
"created": "example",
"dataUrl": "example",
"db": false,
"deleted": false,
"editUrl": "example",
"encrypted": false,
"folder": 1,
"id": 1,
"inactive": false,
"isWorkflowForm": false,
"isWorkflowPublished": false,
"language": "example",
"name": "example",
"numberOfColumns": "example",
"progressMeter": "example",
"shouldDisplayOneQuestionAtATime": false,
"submissions": "example",
"submissionsCount": 1,
"submissionsUnread": "example",
"submitButtonTitle": "example",
"summaryUrl": "example",
"thumbnailUrl": "example",
"timezone": "example",
"unreadSubmissionsCount": 1,
"updated": "example",
"url": "example",
"version": "example",
"viewKey": "example",
"views": "example"
}
}Delete submission
Permanently delete a submission and all associated data.
Inputs
- Submission id
submission_idnumberRequired - Submission id.
Outputs
dataobject- Submission delete response
Example output
{
"data": {
"id": 1
}
}Get field
Retrieve detailed information about a specific field.
Inputs
- Form
form_idnumberRequired - Form id.
- Field id
field_idnumberRequired - Field id.
Outputs
dataobject- Field details
Example output
{
"data": {
"attributes": {
"confirmationText": "example",
"hideInputCharacters": false,
"maxLength": 1,
"minLength": 1,
"placeholder": "example",
"removeDataFromEmailsAndExports": false,
"requireConfirmation": false,
"restrictDataAccess": false
},
"columnSpan": 1,
"datetimeCalculations": {
"calculationAllowNegatives": false,
"calculationOperator": "+",
"calculationType": "date",
"calculationUnits": "days",
"fieldOneCalculation": "example",
"fieldTwoCalculation": "example"
},
"defaultValue": "example",
"displayOrder": 1,
"hidden": false,
"hideLabel": false,
"id": 1,
"internalLabel": "example",
"label": "example",
"labelKey": "example",
"language": "example",
"logic": {
"action": "example",
"fields": [],
"operator": "example"
},
"numericCalculations": [],
"options": [],
"readOnly": false,
"required": false,
"smartListId": 1,
"supportingText": "example",
"type": "example",
"unique": false,
"useCallout": false
}
}Get form
Retrieve detailed information about a specific form.
Inputs
- Form
form_idnumberRequired - Form id.
- With fields
with_fieldstrue/false - Include form fields in responseDefault:
false.
Outputs
dataobject- Form details response
Example output
{
"data": {
"canEdit": false,
"created": "example",
"fields": [],
"folder": 1,
"formExtras": {
"fieldLabelsPosition": "example",
"language": "example",
"numberOfColumns": 1,
"showProgressIndicator": false,
"skipValidationBetweenPages": false,
"useCaptcha": false,
"useFieldPrefill": false,
"useOneQuestionAtATime": false,
"usePromptForLocation": false,
"useSaveAndResume": false,
"useSecurityLogo": false
},
"formSettings": {
"alias": "example",
"isActive": false,
"saveSubmissionsToDatabase": false,
"timezone": "example"
},
"hasApprovers": false,
"id": 1,
"isEncrypted": false,
"isWorkflowForm": false,
"isWorkflowPublished": false,
"name": "example",
"permissions": 1,
"submissionsCount": 1,
"submitButtonTitle": "example",
"todaySubmissionsCount": 1,
"unreadSubmissionsCount": 1,
"updated": "example",
"url": "example",
"version": 1,
"viewKey": "example"
}
}Get form html
Retrieve HTML markup for a specific form.
Inputs
- Form
form_idnumberRequired - Form id.
Outputs
dataobject- Form HTML response
Example output
{
"data": {
"html": "example",
"id": 1,
"name": "example"
}
}Get submission
Retrieve detailed information about a specific submission.
Inputs
- Submission id
submission_idnumberRequired - Submission id.
- X- f s- encryption- password
x__f_s__encryption__passwordtext - X f s encryption password.
Outputs
dataobject- Comprehensive response containing all details of a submission
Example output
{
"data": {
"approvalStatus": "example",
"data": [],
"formId": 1,
"id": 1,
"latitude": "example",
"longitude": "example",
"paymentStatus": "example",
"portal": [],
"prettyFieldId": 1,
"remoteAddr": "example",
"timestamp": "example",
"userAgent": "example",
"workflow": []
}
}List fields
Retrieve all fields from a form.
Inputs
- Form
form_idnumberRequired - Form id.
Outputs
dataobject- Field listing response
Example output
{
"data": {
"fields": []
}
}List folders
Get all folders on your account and their subfolders.
Inputs
- Page
pagenumber - Page.
- Per page
per_pagenumber - Per page.
Outputs
dataobject- Folders listing response
Example output
{
"data": {
"folders": [],
"page": {
"pageNumber": 1,
"pageSize": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}
}
}List form submissions
Retrieve a paginated list of submissions for a specific form.
Inputs
- Form
form_idnumberRequired - Form id.
- Page number
page_numbernumber - Page to use when paginating through items.At least 1.
- Page size
page_sizenumber - Number of items to return per page.From 10 to 500. Default:
50. - Order
ordertext - Order direction of results.One of:
ASC,DESC. Default:ASC. - Keyword
keywordtext - Keyword to search.
- Min time
min_timedate and time - Return submissions at and after given date/time - YYYY-MM-DD or YYYY-MM-DD HH:MM:SS expected (Based around Eastern Time).
- Max time
max_timedate and time - Return submissions at and before given date/time - YYYY-MM-DD or YYYY-MM-DD HH:MM:SS expected (Based around Eastern Time).
- Search
searchlist - Array of search criteria to filter submissions by specific field values. Each criterion must include a fieldId and value. Maximum 10 search criteria allowed (index 0-9).
- Data
datatext - Flag to include submission data.
- Expand data
expand_datatext - Flag to expand submission data.
- Pretty name
pretty_nametext - Flag to include pretty name.
- Data format
data_formattext - Shape of the 'data' field when data=true. 'legacy' (default): map keyed by field id with value/flat_value/internal_label. 'standardized': array of field objects matching GET /submissions/{id} with displayValue/parsedValue/internalLabel.One of:
legacy,standardized. Default:legacy. - X- f s- encryption- password
x__f_s__encryption__passwordtext - X f s encryption password.
Outputs
dataobject- Form submissions listing response
Example output
{
"data": {
"page": {
"pageNumber": 1,
"pageSize": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
},
"submissions": []
}
}List forms
Retrieve a paginated list of forms with optional filtering and sorting.
Inputs
- Page number
page_numbernumber - Page to use when paginating through items.At least 1.
- Page size
page_sizenumber - Number of items to return per page.From 10 to 500. Default:
50. - Search
searchtext - Search by form name
- Order by
order_bytext - Column to order results.
- Order
ordertext - Order direction of results.One of:
ASC,DESC. Default:ASC. - Folder
foldernumber - Forms from specified folder.
Outputs
dataobject- Forms listing response
Example output
{
"data": {
"forms": [],
"page": {
"pageNumber": 1,
"pageSize": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}
}
}Prefill form
Generate a prefilled form URL with specified field values.
Inputs
- Form
form_idnumberRequired - Form id.
- Incomplete password
incomplete_passwordtext - Password for prefill
- Workflow step key
workflow_step_keytext - Internal use only. Used by Workflows (Copilot) to link form submissions back to workflow steps. Not applicable for standard API usage.
- Fields
fieldslist - Array of field data to prefill with their values
- Field values
field_valuesobject - Fill in the form fields. Text values are converted to Formstack values automatically.
Outputs
dataobject- Prefill response
Example output
{
"data": {
"prefilledUrl": "example"
}
}Update field
Update an existing field within the specified form.
Inputs
- Form
form_idnumberRequired - Form id.
- Field id
field_idnumberRequired - Field id.
- Label
labeltext - Label of the field
- Type
typetext - Type of the fieldOne of:
text,textarea,checkbox,radio,select,number,name,email,phone,address, and 12 more. - Internal label
internal_labeltext - Internal label of the field
- Supporting text
supporting_texttext - Description of the field
- Use callout
use_callouttrue/false - Flag to show the description in a callout boxDefault:
false. - Required
requiredtrue/false - Flag to mark field as requiredDefault:
false. - Read only
read_onlytrue/false - Flag to not allow the field to be changedDefault:
false. - Hidden
hiddentrue/false - Flag to hide the fieldDefault:
false. - Unique
uniquetrue/false - Flag to mark field as requiring a unique valueDefault:
false. - Hide label
hide_labeltrue/false - Flag to show or hide the labelDefault:
false. - Column span
column_spannumber - Determines how many columns this field takes on the live formDefault:
1. - Language
languagetext - Language of the fieldOne of:
default,af,sq,ar,bg,zh,zh-TW,hr,cs,da, and 27 more. Default:default. - Default value
default_valuetext - Default value of the field on the live form
- Options
optionslist - Options attached to field
- Smart list id
smart_list_idnumber - ID of smart list to attach
- Unlink smart list
unlink_smart_listtrue/false - Flag to unlink smart list from field
- Attributes
attributesobject - Field attributes component
- Logic
logicobject - Field logic conditions for conditional processing
- Numeric calculation
numeric_calculationobject - Numeric calculation definition for this field
- Datetime calculation
datetime_calculationobject - Datetime calculation definition for this field
Outputs
dataobject- Field details
Example output
{
"data": {
"attributes": {
"confirmationText": "example",
"hideInputCharacters": false,
"maxLength": 1,
"minLength": 1,
"placeholder": "example",
"removeDataFromEmailsAndExports": false,
"requireConfirmation": false,
"restrictDataAccess": false
},
"columnSpan": 1,
"datetimeCalculations": {
"calculationAllowNegatives": false,
"calculationOperator": "+",
"calculationType": "date",
"calculationUnits": "days",
"fieldOneCalculation": "example",
"fieldTwoCalculation": "example"
},
"defaultValue": "example",
"displayOrder": 1,
"hidden": false,
"hideLabel": false,
"id": 1,
"internalLabel": "example",
"label": "example",
"labelKey": "example",
"language": "example",
"logic": {
"action": "example",
"fields": [],
"operator": "example"
},
"numericCalculations": [],
"options": [],
"readOnly": false,
"required": false,
"smartListId": 1,
"supportingText": "example",
"type": "example",
"unique": false,
"useCallout": false
}
}Update form
Update an existing form's properties.
Inputs
- Form
form_idnumberRequired - Form id.
- Name
nametext - Name of the form
- Template
templatenumber - ID of template of the form
- Stock template
stock_templatetext - Stock theme template code for the formOne of:
berryNice,blueAfterglow,calmZigZag,celadonParchment,clean,confetti,corporateOffice,dark,duskPop,formstack, and 7 more. Default:light. - Folder
foldernumber - ID of the folder where the form will be moved
- Submit button title
submit_button_titletext - Title of submit button on live form
- Number of columns
number_of_columnsnumber - Number of visible columns in the form
- Field labels position
field_labels_positiontext - Position where field labels are placed on the live formOne of:
top,left. - Save submissions to database
save_submissions_to_databasetrue/false - Flag to disable or enable submissions to be saved in our database
- Timezone
timezonetext - Timezone of the formOne of:
Pacific/Kwajalein,Pacific/Midway,Pacific/Honolulu,America/Anchorage,US/Pacific,US/Arizona,US/Mountain,US/Central,America/Mexico_City(America/mexico city),Canada/Saskatchewan, and 42 more. - Language
languagetext - Language of the formOne of:
af,sq,ar,bg,zh,zh-TW,hr,cs,da,nl, and 26 more. - Is active
is_activetrue/false - Flag to make the form active/inactive
- Disabled message
disabled_messagetext - The message to show when the form is inactive
Outputs
dataobject- Form details response
Example output
{
"data": {
"canEdit": false,
"created": "example",
"fields": [],
"folder": 1,
"formExtras": {
"fieldLabelsPosition": "example",
"language": "example",
"numberOfColumns": 1,
"showProgressIndicator": false,
"skipValidationBetweenPages": false,
"useCaptcha": false,
"useFieldPrefill": false,
"useOneQuestionAtATime": false,
"usePromptForLocation": false,
"useSaveAndResume": false,
"useSecurityLogo": false
},
"formSettings": {
"alias": "example",
"isActive": false,
"saveSubmissionsToDatabase": false,
"timezone": "example"
},
"hasApprovers": false,
"id": 1,
"isEncrypted": false,
"isWorkflowForm": false,
"isWorkflowPublished": false,
"name": "example",
"permissions": 1,
"submissionsCount": 1,
"submitButtonTitle": "example",
"todaySubmissionsCount": 1,
"unreadSubmissionsCount": 1,
"updated": "example",
"url": "example",
"version": 1,
"viewKey": "example"
}
}Update submission
Update an existing submission with new data.
Inputs
- Submission id
submission_idnumberRequired - Submission id.
- X- f s- encryption- password
x__f_s__encryption__passwordtext - X f s encryption password.
- Fields
fieldslist - Fields of the submission
- User agent
user_agenttext - User agent of the submission
- Remote addr
remote_addrtext - Remote addr of the submission
- Payment status
payment_statustext - Payment status of the submission
- Read
readtext - Flag to mark the submission as read
- Timestamp
timestamptext - Timestamp of the submission
- Field values
field_valuesobject - Fill in the form fields. Text values are converted to Formstack values automatically.
Outputs
dataobject- Submission edit response
Example output
{
"data": {
"formId": 1,
"id": 1,
"paymentStatus": "example",
"read": "example",
"remoteAddr": "example",
"timestamp": "example",
"userAgent": "example"
}
}