List Submissions
form_io.list_submissions
ActionBusiness appsconnection required
Calls the Form.io API with the connection's credentials.
List a form's submissions, optionally filtered by its own data fields.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Form.io
- Secret shape
- {"api_key": "…"} for a project API key, or {"jwt_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 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 Identifier of the form, as returned by form_io.list_forms. | string | Yes | — | — | 5e5b6d4f0a1b2c3d4e5f6a7b |
limit Maximum number of submissions to return in one page. | number | No | 10 | ≥ 1 | — |
sort Field to sort by; prefix it with a minus for descending order. | string | No | — | — | -created |
query Extra Form.io filter parameters, as a JSON object; dotted data filters such as data.date__gte go here. | object | No | — | — | {"data.status":"approved"} |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"form_id": "5e5b6d4f0a1b2c3d4e5f6a7b",
"limit": 10,
"query": {
"data.status": "approved"
},
"sort": "-created"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
submissions The submissions Form.io returned for this page. | array | — |
count How many submissions the page carried. | number | — |
{
"count": 0,
"submissions": []
}See List Submissions run in a workflow.
In a technical demo we add the Form.io connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.