Get Form
kobotoolbox.get_form
ActionBusiness appsconnection required
Calls the KoboToolbox API with the connection's credentials.
Retrieve one form with its settings, deployment state and content.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- KoboToolbox
- Secret shape
- the API token, or {"api_key": "…"}
- 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 |
|---|---|---|---|---|---|
asset_uid The uid of the KoboToolbox form (asset) to act on, as it appears in its URL. | string | Yes | — | — | aSAvYreNzVEkrWg5Gdcvg |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"asset_uid": "aSAvYreNzVEkrWg5Gdcvg"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
uid The form's uid. | string | — |
name The form's name. | string | — |
asset_type What kind of asset this is, such as survey. | string | — |
url The API URL of this asset. | string | — |
date_created When the form was created. | string | — |
date_modified When the form was last changed. | string | — |
has_deployment True once the form has been deployed. | boolean | — |
deployment__submission_count How many submissions it holds. | number | — |
settings The form's settings block. | object | — |
{
"asset_type": "",
"date_created": "",
"date_modified": "",
"deployment__submission_count": 0,
"has_deployment": false,
"name": "",
"settings": {},
"uid": "",
"url": ""
}Related KoboToolbox nodes
See Get Form run in a workflow.
In a technical demo we add the KoboToolbox connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.