List Forms
form_io.list_forms
ActionBusiness appsconnection required
Calls the Form.io API with the connection's credentials.
List the forms and resources defined on the project.
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
5 fields, none 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_type Only return entries of this kind; leave blank for both. | string | No | — | one of "form", "resource" | — |
limit Maximum number of forms to return in one page. | number | No | 10 | ≥ 1 | — |
skip How many forms to skip before the page starts, for paging through them. | number | No | 0 | ≥ 0 | — |
sort Field to sort by; prefix it with a minus for descending order. | string | No | — | — | -created |
select Comma-separated list of fields to return, which keeps the response small. | string | No | — | — | _id,title,path |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 10,
"select": "_id,title,path",
"skip": 0,
"sort": "-created"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
forms The forms Form.io returned for this page. | array | — |
count How many forms the page carried. | number | — |
{
"count": 0,
"forms": []
}See List Forms 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.