Get Submission
kobotoolbox.get_submission
ActionBusiness appsconnection required
Calls the KoboToolbox API with the connection's credentials.
Retrieve one submission of a form by its numeric id or its rootUuid.
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, 2 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 |
submission_id The submission's numeric id (_id) or its rootUuid. | string | Yes | — | — | 18 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"asset_uid": "aSAvYreNzVEkrWg5Gdcvg",
"submission_id": "18"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
_id The submission's numeric id. | number | — |
_uuid The submission's uuid. | string | — |
_submission_time When KoBo received the submission. | string | — |
_xform_id_string The form id the submission belongs to. | string | — |
__version__ Which deployed version of the form was used. | string | — |
_attachments Files attached to the submission. | array | — |
_validation_status The submission's validation status. | object | — |
{
"__version__": "",
"_attachments": [],
"_id": 0,
"_submission_time": "",
"_uuid": "",
"_validation_status": {},
"_xform_id_string": ""
}Related KoboToolbox nodes
See Get Submission 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.