List Files
kobotoolbox.list_files
ActionBusiness appsconnection required
Calls the KoboToolbox API with the connection's credentials.
List the media files and map layers attached to a form.
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
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 |
|---|---|---|---|---|---|
asset_uid The uid of the KoboToolbox form (asset) to act on, as it appears in its URL. | string | Yes | — | — | aSAvYreNzVEkrWg5Gdcvg |
file_type Only return files of this kind; leave unset to return both kinds. | string | No | — | one of "form_media", "map_layer" | — |
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 |
|---|---|---|
files One entry per file on the form. | array | — |
count How many records this page carried. | number | — |
total How many records match in total, across all pages. | number | — |
next URL of the next page, empty when this is the last one. | string | — |
previous URL of the previous page, empty on the first one. | string | — |
has_more True while another page of results exists. | boolean | — |
asset_uid The form the files belong to. | string | — |
{
"asset_uid": "",
"count": 0,
"files": [],
"has_more": false,
"next": "",
"previous": "",
"total": 0
}Related KoboToolbox nodes
See List Files 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.