list_mobile_workers
Retrieve mobile workers (field users) in a CommCare project. Mobile workers are the users who collect data using the CommCare mobile app.
Returns user details including username, name, contact info, groups, and custom user data.
get_case
Retrieve a single case by its ID. Returns the full case record including all properties, indices (relationships to other cases), form submissions, and metadata.
manage_group
Create a new user group or update an existing one. Groups organize mobile workers for case sharing, reporting, and data access control.
To create, provide a name. To update, provide the groupId along with the fields to change.
list_forms
Search and retrieve submitted form data from a CommCare project. Forms capture data collected during a single interaction.
Filter by form type (xmlns), date received, application, and more. Returns paginated results including form responses and metadata.
update_case
Update an existing case in CommCare. Modify case properties, change ownership, update relationships (indices), or close the case.
Can also be used to reopen a closed case by setting close to false.
create_case
Create a new case in CommCare. Cases are the core data records used for longitudinal tracking (e.g., patients, households, facilities).
Specify the case type, name, owner, and any custom properties. Optionally set relationships to other cases via indices.
list_web_users
Retrieve web users for a CommCare project. Web users are administrative users who access CommCare HQ via the web interface for project management, reporting, and configuration.
bulk_cases
Create or update multiple cases in a single request. Each entry can either create a new case (omit caseId) or update an existing case (provide caseId).
Supports up to 100 cases per request. Useful for batch imports, migrations, or synchronized updates.
list_applications
Retrieve applications in a CommCare project. Applications define the forms, modules, and case structure used for data collection.
Useful for understanding the data model and discovering form types available in the project.
send_sms
Send an SMS message through CommCare to a phone number. Useful for automated notifications, reminders, or follow-up messages.
Requires an SMS gateway to be configured on the CommCare project.
get_form
Retrieve a single submitted form by its ID. Returns the full form data including all question responses, metadata (device info, timestamps, submitting user), and application details.
list_lookup_tables
Retrieve lookup tables (fixtures) in a CommCare project. Lookup tables store reference data used across forms and workflows, such as health facility names, geographic locations, or standardized options.
list_cases
Search and retrieve cases from a CommCare project. Cases are the core longitudinal data records that track ongoing interactions (e.g., patients, households).
Supports filtering by case type, owner, modification date, status, and more. Returns paginated results with case properties and metadata.
manage_mobile_worker
Create a new mobile worker or update an existing one. Mobile workers are field users who collect data via the CommCare mobile app.
To create, provide a username and password. To update, provide the userId of an existing worker along with the fields to change.
list_groups
Retrieve user groups in a CommCare project. Groups organize mobile workers for case sharing, reporting, and access control.