Skip to main content
KoboToolbox logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: KOBOTOOLBOX
  • Version: 20261101_00

Tools

Slug: KOBOTOOLBOX_CREATE_PROJECTCreate a draft survey project, optionally by cloning an existing KoboToolbox asset.

Input Parameters

string
required
Name for the new survey project.
string
Sector metadata for a blank survey. Ignored when clone_from is set.
string
Country metadata for a blank survey. Ignored when clone_from is set.
string
UID of an existing KoboToolbox asset to clone; omit to create a blank survey.
string
Project description for a blank survey. Ignored when clone_from is set.
boolean
Whether to share project metadata for a blank survey. Ignored when clone_from is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KOBOTOOLBOX_DELETE_EXPORTDelete one asynchronous export job from a KoboToolbox project.

Input Parameters

string
required
UID of the export job to delete.
string
required
UID of the project that owns the export job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KOBOTOOLBOX_DELETE_PROJECTPermanently delete one KoboToolbox project by UID.

Input Parameters

string
required
UID of the single project to permanently delete; verify it with GET_PROJECT first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KOBOTOOLBOX_DEPLOY_PROJECTDeploy a draft KoboToolbox survey or redeploy its latest form version so it can accept and expose submissions.

Input Parameters

boolean
Whether the resulting deployment is active; normally leave true.
string
required
UID of the survey project to deploy or redeploy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KOBOTOOLBOX_EXPORT_SUBMISSIONSCreate an asynchronous KoboToolbox submission export and wait for it to complete, returning the export UID and any available result URL.

Input Parameters

object
Mongo-style Kobo filter object restricting exported submissions.
array
XML column names to include; an empty list includes all fields.
boolean
Flatten GeoJSON output where applicable.
string
Form translation label to use, or ‘_xml’ for XML names and values.
string ("csv" | "geojson" | "spss_labels" | "xls")
Output format for the export.
string
required
UID of the deployed project to export.
array
Submission integer IDs to export; an empty list exports all submissions matching query.
string
Non-empty separator used for nested group names.
string ("both" | "summary" | "details")
How select-multiple responses are represented.
boolean
Include media URL columns for CSV and XLS exports.
boolean
Write XLS values as text where applicable.
boolean
Include the group hierarchy in human-readable labels.
number
Maximum time to poll the export job before reporting a timeout, up to 180 seconds.
boolean
Include fields from every deployed form version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KOBOTOOLBOX_GET_PROJECTRetrieve a KoboToolbox project with its form content, settings, resource URLs, and deployment state.

Input Parameters

string
required
UID of the KoboToolbox project to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KOBOTOOLBOX_GET_SUBMISSIONRetrieve one submission by integer ID, root UUID, or submission UUID from a KoboToolbox project.

Input Parameters

string
required
UID of the project containing the submission.
string
required
Submission primary key, _uuid, or rootUuid without the ‘uuid:’ prefix; prefer the primary key or rootUuid because _uuid can match multiple records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KOBOTOOLBOX_LIST_ASSETSFind projects and other visible assets in the connected KoboToolbox account, returning one page and a continuation cursor.

Input Parameters

integer
Maximum assets to return in this page; must be at least 1.
string
Kobo asset search expression, such as a project name or supported field filter.
string ("asset_type" | "date_modified" | "date_deployed" | "date_modified__date" | "date_deployed__date" | "name" | "settings__sector" | "settings__sector__value" | "settings__description" | "owner__username" | "owner__extra_details__data__name" | "owner__extra_details__data__organization" | "owner__email" | "_deployment_status" | "last_modified_by" | "subscribers_count" | "-asset_type" | "-date_modified" | "-date_deployed" | "-date_modified__date" | "-date_deployed__date" | "-name" | "-settings__sector" | "-settings__sector__value" | "-settings__description" | "-owner__username" | "-owner__extra_details__data__name" | "-owner__extra_details__data__organization" | "-owner__email" | "-_deployment_status" | "-last_modified_by" | "-subscribers_count")
Documented Kobo asset field used to order results; ’-’ prefixes descending values.
string
Opaque continuation cursor from a previous response; omit for the first page.
boolean
Return only the connected user’s own permission assignments within each result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KOBOTOOLBOX_LIST_SUBMISSIONSRead one page of submissions for a deployed KoboToolbox project, with optional field selection, filtering, and sorting.

Input Parameters

string
JSON-encoded sort object, for example {“_id”:-1}.
integer
Maximum submissions in this page, from 1 through 1000.
string
JSON-encoded Mongo-style Kobo submission filter, for example {“_submission_time”:{“$gt”:“2026-01-01T00:00:00”}}.
string
JSON-encoded array of XML field names to return, for example ’[“household_name”,“age”]’.
string
Opaque continuation cursor from a previous response; omit for the first page.
string
required
UID of the deployed project whose submissions should be read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not