List Submissions
kobotoolbox.list_submissions
ActionBusiness appsconnection required
Calls the KoboToolbox API with the connection's credentials.
List a form's submissions, optionally filtered by a MongoDB-style query.
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
6 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 |
query MongoDB-style filter over the submitted data, such as {"_submission_time": {"$gt": "2026-01-01T00:00:00"}}. | object | No | — | — | {"_submission_time":{"$gt":"2026-01-01T00:00:00"}} |
sort Sort order as a MongoDB sort document, such as {"_id": -1}. | object | No | — | — | {"_id":-1} |
fields Only return these fields of each submission, by name. | array | No | — | array of string | ["_id","_submission_time"] |
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.
{
"asset_uid": "aSAvYreNzVEkrWg5Gdcvg",
"fields": [
"_id",
"_submission_time"
],
"query": {
"_submission_time": {
"$gt": "2026-01-01T00:00:00"
}
},
"sort": {
"_id": -1
}
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
submissions One entry per submission, each carrying the answers plus KoBo's _id, _uuid, _submission_time and _attachments metadata. | 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 submissions were read from. | string | — |
{
"asset_uid": "",
"count": 0,
"has_more": false,
"next": "",
"previous": "",
"submissions": [],
"total": 0
}Related KoboToolbox nodes
See List Submissions 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.