Get Form
form_io.get_form
ActionBusiness appsconnection required
Calls the Form.io API with the connection's credentials.
Fetch one form's definition, including every component on it.
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
1 field, 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 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"form_id": "5e5b6d4f0a1b2c3d4e5f6a7b"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
_id Identifier of the form. | string | — |
title Human-readable name of the form. | string | — |
name Machine name of the form. | string | — |
path API path the form is reachable at within the project. | string | — |
type Whether this is a form or a resource. | string | — |
display How the form renders: form, wizard or pdf. | string | — |
components The component definitions that make up the form. | array | — |
created ISO-8601 timestamp of when the form was created. | string | — |
modified ISO-8601 timestamp of when the form was last changed. | string | — |
{
"_id": "",
"components": [],
"created": "",
"display": "",
"modified": "",
"name": "",
"path": "",
"title": "",
"type": ""
}See Get Form 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.