---
canonical_url: "https://docs.composio.dev/toolkits/kobotoolbox"
markdown_url: "https://docs.composio.dev/toolkits/kobotoolbox.md"
product: "platform"
version: null
last_updated: null
---

# KoboToolbox

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

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

## Tools

### Create Project

**Slug:** `KOBOTOOLBOX_CREATE_PROJECT`

Create a draft survey project, optionally by cloning an existing KoboToolbox asset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new survey project. |
| `sector` | string | No | Sector metadata for a blank survey. Ignored when clone_from is set. |
| `country` | string | No | Country metadata for a blank survey. Ignored when clone_from is set. |
| `clone_from` | string | No | UID of an existing KoboToolbox asset to clone; omit to create a blank survey. |
| `description` | string | No | Project description for a blank survey. Ignored when clone_from is set. |
| `share_metadata` | boolean | No | Whether to share project metadata for a blank survey. Ignored when clone_from is set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Export

**Slug:** `KOBOTOOLBOX_DELETE_EXPORT`

Delete one asynchronous export job from a KoboToolbox project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `export_uid` | string | Yes | UID of the export job to delete. |
| `project_uid` | string | Yes | UID of the project that owns the export job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `KOBOTOOLBOX_DELETE_PROJECT`

Permanently delete one KoboToolbox project by UID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_uid` | string | Yes | UID of the single project to permanently delete; verify it with GET_PROJECT first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | No | Whether the resulting deployment is active; normally leave true. |
| `project_uid` | string | Yes | UID of the survey project to deploy or redeploy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Submissions

**Slug:** `KOBOTOOLBOX_EXPORT_SUBMISSIONS`

Create an asynchronous KoboToolbox submission export and wait for it to complete, returning the export UID and result URL.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `KOBOTOOLBOX_GET_PROJECT`

Retrieve a KoboToolbox project with its form content, settings, resource URLs, and deployment state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_uid` | string | Yes | UID of the KoboToolbox project to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Submission

**Slug:** `KOBOTOOLBOX_GET_SUBMISSION`

Retrieve one submission by integer ID, root UUID, or submission UUID from a KoboToolbox project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_uid` | string | Yes | UID of the project containing the submission. |
| `submission_id` | string | Yes | Submission primary key, _uuid, or rootUuid without the 'uuid:' prefix; prefer the primary key or rootUuid because _uuid can match multiple records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum assets to return in this page; must be at least 1. |
| `query` | string | No | 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") | No | Documented Kobo asset field used to order results; '-' prefixes descending values. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response; omit for the first page. |
| `current_user_permissions_only` | boolean | No | Return only the connected user's own permission assignments within each result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | JSON-encoded sort object, for example {"_id":-1}. |
| `limit` | integer | No | Maximum submissions in this page, from 1 through 1000. |
| `query` | string | No | JSON-encoded Mongo-style Kobo submission filter, for example {"_submission_time":{"$gt":"2026-01-01T00:00:00"}}. |
| `fields` | string | No | JSON-encoded array of XML field names to return, for example '["household_name","age"]'. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response; omit for the first page. |
| `project_uid` | string | Yes | UID of the deployed project whose submissions should be read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |