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

# CommCare

> CommCare is a mobile data collection and case management platform for health and social programs

![CommCare logo](https://mintcdn.com/composio-preview/NPf8agM6UrvZD-Iu/images/toolkits/commcare.svg?fit=max\&auto=format\&n=NPf8agM6UrvZD-Iu\&q=85\&s=3adda233475680707e67841b9bc16923)

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

## Tools

> [accordion] Create Lookup Table
>
> **Slug:** `COMMCARE_CREATE_LOOKUP_TABLE`
>
> Tool to create a new lookup table in a CommCare domain. Use when you need to set up reference data structures like product catalogs, price lists, or configuration tables. Requires 'Edit Apps' permission.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> The name/identifier of the lookup table. This is used to reference the table in applications.
>
> **domain** `string` *required*
>
> The CommCare domain/project identifier where the lookup table will be created.
>
> **fields** `array` *required*
>
> Array of field definitions for the lookup table. Each field must have a field\_name and optional properties array.
>
> **is\_global** `boolean`
>
> Indicates whether the lookup table is accessible to all users in the domain. Defaults to false if not specified.
>
> #### 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] Create Web User Invitation
>
> **Slug:** `COMMCARE_CREATE_WEB_USER_INVITATION`
>
> Tool to create an invitation for a new web user in CommCare. Use when you need to invite a user with specific role and permissions. Requires 'Edit Web Users & Edit Access API' permissions.
>
> #### Input Parameters
>
> **role** `string` *required*
>
> Role designation for the user (e.g., 'App Editor', 'Admin')
>
> **email** `string` *required*
>
> Email address of the user to invite
>
> **domain** `string` *required*
>
> CommCare domain name where the invitation will be created
>
> **profile** `string`
>
> Profile to assign to the user
>
> **user\_data** `object`
>
> Custom data fields associated with the user
>
> **tableau\_role** `string`
>
> Tableau role (Explorer, ExplorerCanPublish, SiteAdministratorExplorer, Viewer, Unlicensed)
>
> **tableau\_groups** `array`
>
> List of Tableau groups for user assignment
>
> **primary\_location\_id** `string`
>
> Location ID for primary assignment (must be in assigned locations)
>
> **assigned\_location\_ids** `array`
>
> List of location IDs the web user will access
>
> #### 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 Reports
>
> **Slug:** `COMMCARE_LIST_REPORTS`
>
> Tool to retrieve available reports configured in a CommCare project. Use when you need to discover what reports exist before downloading report data via the Download Report Data API.
>
> #### Input Parameters
>
> **project** `string` *required*
>
> The CommCare project identifier. This is the project space name where reports are configured.
>
> #### 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] Single Sign On
>
> **Slug:** `COMMCARE_SINGLE_SIGN_ON`
>
> Tool to validate login credentials and retrieve user profile for a mobile worker or web user. Use when you need to authenticate a user and obtain their profile information including roles, permissions, locations, and configuration details.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> The CommCare domain/project identifier where the user account exists.
>
> **password** `string` *required*
>
> The user's authentication password for login validation.
>
> **username** `string` *required*
>
> The user's login identifier (mobile worker or web user username).
>
> #### 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] Submit Form ODK Compatible
>
> **Slug:** `COMMCARE_SUBMIT_FORM_ODK_COMPATIBLE`
>
> Tool to submit form data using ODK-compatible endpoint for Android client compatibility. Use when submitting XForm data to CommCare. Requires properly formatted XML with metadata including unique instanceID.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> The CommCare project domain name where the form will be submitted.
>
> **xml\_form\_data** `string` *required*
>
> Complete XForm XML data as a string. Must include root \<data> element with xmlns, name, and version attributes. Must contain an n1:meta node with required fields: deviceID, timeStart (ISO 8601), timeEnd (ISO 8601), username, userID (UUID), and instanceID (UUID4, must be unique).
>
> #### 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] Submit Form to Application
>
> **Slug:** `COMMCARE_SUBMIT_FORM_TO_APP`
>
> Tool to submit an XForm to a specific CommCare application. Use when you need to submit form data and tag it with a specific application ID. The form is submitted as XML following the OpenRosa standard with required metadata fields.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> The CommCare project domain/space where the form will be submitted.
>
> **form\_xml** `string` *required*
>
> Complete XForm XML content following OpenRosa standard. Must include root \<data> element with xmlns, name, and version attributes. Must contain a \<meta> section with required fields: deviceID, timeStart (ISO 8601 format), timeEnd (ISO 8601 format), username, userID, and instanceID (must be a unique UUID4 in format 'uuid:...' or just the UUID).
>
> **application\_id** `string` *required*
>
> Application ID to tag the form submission with. This associates the submission with a specific CommCare application.
>
> #### 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
