List Forms
kobotoolbox.list_forms
ActionBusiness appsconnection required
Calls the KoboToolbox API with the connection's credentials.
List the forms and projects the API token can reach, one page at a time.
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
4 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 |
|---|---|---|---|---|---|
query KoBo search expression, such as name__icontains:household. | string | No | — | — | name__icontains:household |
ordering Field to sort by; prefix it with a minus sign for descending order. | string | No | — | — | -date_modified |
limit How many records to return in one page; the server allows up to 1000. | number | No | — | 1–1000 | — |
start Zero-based index of the first record to return, for paging through results. | number | No | — | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"ordering": "-date_modified",
"query": "name__icontains:household"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
forms One entry per form, each the asset object KoBo returned. | 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 | — |
{
"count": 0,
"forms": [],
"has_more": false,
"next": "",
"previous": "",
"total": 0
}Related KoboToolbox nodes
See List Forms 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.