> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# KoboToolbox

> KoboToolbox is a data collection platform for building forms, managing survey projects, collecting submissions, and exporting humanitarian and research data.

![KoboToolbox logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/kobotoolbox.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=082a89296fa408f46f0d388672b9ce5c)

* **Category:** forms & surveys
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 9
* **Triggers:** 0
* **Slug:** `KOBOTOOLBOX`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Project
>
> **Slug:** `KOBOTOOLBOX_CREATE_PROJECT`
>
> Create a draft survey project, optionally by cloning an existing KoboToolbox asset.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name for the new survey project.
>
> **sector** `string`
>
> Sector metadata for a blank survey. Ignored when clone\_from is set.
>
> **country** `string`
>
> Country metadata for a blank survey. Ignored when clone\_from is set.
>
> **clone\_from** `string`
>
> UID of an existing KoboToolbox asset to clone; omit to create a blank survey.
>
> **description** `string`
>
> Project description for a blank survey. Ignored when clone\_from is set.
>
> **share\_metadata** `boolean`
>
> Whether to share project metadata for a blank survey. Ignored when clone\_from is set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Export
>
> **Slug:** `KOBOTOOLBOX_DELETE_EXPORT`
>
> Delete one asynchronous export job from a KoboToolbox project.
>
> #### Input Parameters
>
> **export\_uid** `string` *required*
>
> UID of the export job to delete.
>
> **project\_uid** `string` *required*
>
> UID of the project that owns the export job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Project
>
> **Slug:** `KOBOTOOLBOX_DELETE_PROJECT`
>
> Permanently delete one KoboToolbox project by UID.
>
> #### Input Parameters
>
> **project\_uid** `string` *required*
>
> UID of the single project to permanently delete; verify it with GET\_PROJECT first.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Deploy Project
>
> **Slug:** `KOBOTOOLBOX_DEPLOY_PROJECT`
>
> Deploy a draft KoboToolbox survey or redeploy its latest form version so it can accept and expose submissions.
>
> #### Input Parameters
>
> **active** `boolean`
>
> Whether the resulting deployment is active; normally leave true.
>
> **project\_uid** `string` *required*
>
> UID of the survey project to deploy or redeploy.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export Submissions
>
> **Slug:** `KOBOTOOLBOX_EXPORT_SUBMISSIONS`
>
> Create an asynchronous KoboToolbox submission export and wait for it to complete, returning the export UID and any available result URL.
>
> #### Input Parameters
>
> **query** `object`
>
> Mongo-style Kobo filter object restricting exported submissions.
>
> **fields** `array`
>
> XML column names to include; an empty list includes all fields.
>
> **flatten** `boolean`
>
> Flatten GeoJSON output where applicable.
>
> **language** `string`
>
> Form translation label to use, or '\_xml' for XML names and values.
>
> **export\_type** `string ("csv" | "geojson" | "spss_labels" | "xls")`
>
> Output format for the export.
>
> **project\_uid** `string` *required*
>
> UID of the deployed project to export.
>
> **submission\_ids** `array`
>
> Submission integer IDs to export; an empty list exports all submissions matching query.
>
> **group\_separator** `string`
>
> Non-empty separator used for nested group names.
>
> **multiple\_select** `string ("both" | "summary" | "details")`
>
> How select-multiple responses are represented.
>
> **include\_media\_url** `boolean`
>
> Include media URL columns for CSV and XLS exports.
>
> **xls\_types\_as\_text** `boolean`
>
> Write XLS values as text where applicable.
>
> **hierarchy\_in\_labels** `boolean`
>
> Include the group hierarchy in human-readable labels.
>
> **wait\_timeout\_seconds** `number`
>
> Maximum time to poll the export job before reporting a timeout, up to 180 seconds.
>
> **fields\_from\_all\_versions** `boolean`
>
> Include fields from every deployed form version.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project
>
> **Slug:** `KOBOTOOLBOX_GET_PROJECT`
>
> Retrieve a KoboToolbox project with its form content, settings, resource URLs, and deployment state.
>
> #### Input Parameters
>
> **project\_uid** `string` *required*
>
> UID of the KoboToolbox project to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Submission
>
> **Slug:** `KOBOTOOLBOX_GET_SUBMISSION`
>
> Retrieve one submission by integer ID, root UUID, or submission UUID from a KoboToolbox project.
>
> #### Input Parameters
>
> **project\_uid** `string` *required*
>
> UID of the project containing the submission.
>
> **submission\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Assets
>
> **Slug:** `KOBOTOOLBOX_LIST_ASSETS`
>
> Find projects and other visible assets in the connected KoboToolbox account, returning one page and a continuation cursor.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum assets to return in this page; must be at least 1.
>
> **query** `string`
>
> Kobo asset search expression, such as a project name or supported field filter.
>
> **ordering** `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.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response; omit for the first page.
>
> **current\_user\_permissions\_only** `boolean`
>
> Return only the connected user's own permission assignments within each result.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Submissions
>
> **Slug:** `KOBOTOOLBOX_LIST_SUBMISSIONS`
>
> Read one page of submissions for a deployed KoboToolbox project, with optional field selection, filtering, and sorting.
>
> #### Input Parameters
>
> **sort** `string`
>
> JSON-encoded sort object, for example \{"\_id":-1}.
>
> **limit** `integer`
>
> Maximum submissions in this page, from 1 through 1000.
>
> **query** `string`
>
> JSON-encoded Mongo-style Kobo submission filter, for example \{"\_submission\_time":\{"\$gt":"2026-01-01T00:00:00"}}.
>
> **fields** `string`
>
> JSON-encoded array of XML field names to return, for example '\["household\_name","age"]'.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response; omit for the first page.
>
> **project\_uid** `string` *required*
>
> UID of the deployed project whose submissions should be read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
