Skip to main content

Retrieve all submissions from KoBoToolbox

Retrieve all submissions from KoBoToolbox.

Application

  • KoBoToolbox

Inputs (what you have)

NameDescriptionData TypeRequired?Example
Connected AccountThe connected account to use for the requestConnected AccountYes
Form IDForm ID (e.g. aSAvYreNzVEkrWg5Gdcvg)Text (Short)Yes
Return all?Whether to return all results or only up to a given limitTrue/FalseYes
LimitMax number of results to returnNumberNo
FilterPredefined Choice ListNo
Filters (JSON)Text (Short)No
Download attachments?Whether to download submitted attachmentsTrue/FalseNo
Attachments naming schemePredefined Choice ListNo
Fields to retrieveComma-separated list of fields to retrieve (e.g. _submission_time,_submitted_by). If left blank, all fields are retrievedText (Long)No
File sizeAttachment size to retrieve, if multiple versions are availablePredefined Choice ListNo
Multiselect maskComma-separated list of wildcard-style selectors for fields that should be treated as multiselect fields, i.e. parsed as arraysText (Long)No
Number maskComma-separated list of wildcard-style selectors for fields that should be treated as numbersText (Long)No
Reformat?Whether to apply some reformatting to the submission data, such as parsing GeoJSON coordinatesTrue/FalseNo
SortSort predicates, in MongoDB JSON format (e.g. {"_submission_time":1})Text (Long)No

Outputs (what you get)

NameDescriptionData TypeRequired?Example
JSON OutputJSON output returned by the APIText (Long)No

Outcomes

NameDescription
SuccessThis status is selected if the job has successfully completed.
UnsuccessfulThis status is selected if the job has completed unsuccessfully.

Requirements

  • N/A