Get Form
formstack.get_form
ActionBusiness appsconnection required
Calls the Formstack API with the connection's credentials.
Retrieve one form's settings, optionally including its field list.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Formstack
- Secret shape
- the Personal Access Token, or {"api_key": "fs_pat_…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
form_id The numeric id of the Formstack form to act on. | string | Yes | — | — | 2721234 |
with_fields Include the form's field definitions in the response. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"form_id": "2721234",
"with_fields": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The numeric id of the form. | number | — |
name The form's name. | string | — |
url The public URL of the live form. | string | — |
viewKey The form's view key, used in its public URL. | string | — |
active True while the form accepts submissions. | boolean | — |
submissions How many submissions the form has taken. | string | — |
created When the form was created. | string | — |
updated When the form was last changed. | string | — |
folder The numeric id of the folder holding the form. | number | — |
{
"active": false,
"created": "",
"folder": 0,
"id": 0,
"name": "",
"submissions": "",
"updated": "",
"url": "",
"viewKey": ""
}See Get Form run in a workflow.
In a technical demo we add the Formstack connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.