Skip to content
Changelog

Report a bug

CommCare integration: operations for AI agents

CommCare connects to Type.com as an integration. This page lists the 64 operations documented for Claude and Codex in Type.com: 31 read, 27 write, 6 destructive.

About CommCare

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

Categories: Documents & Forms

How to connect CommCare to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

64 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

64 operations listed.

  • Read

    List application structures

    List application structures.

    GET /a/{domain}/api/application/v1/

  • Read

    Read application structure

    Read application structure.

    GET /a/{domain}/api/application/v1/{app_id}/

  • Read

    List cases v1

    Read project case data from the version 1 resource.

    GET /a/{domain}/api/case/v1/

  • Read

    Read case v1

    Read project case data from the version 1 resource.

    GET /a/{domain}/api/case/v1/{case_id}/

  • Read

    List cases v2

    Read cases with supported query filters.

    GET /a/{domain}/api/case/v2/

  • Read

    Fetch cases in bulk

    Read multiple cases using identifiers in the request body.

    POST /a/{domain}/api/case/v2/bulk-fetch/

  • Read

    Read case by external identifier

    Find a case by its external identifier.

    GET /a/{domain}/api/case/v2/ext/{external_id}/

  • Read

    Read case v2

    Read one case, or a documented comma-separated list of case identifiers.

    GET /a/{domain}/api/case/v2/{case_id}

  • Read

    Download report data

    Download report data.

    GET /a/{domain}/api/configurablereportdata/v1/{report_id}/

  • Read

    List DET export configurations

    List DET export configurations.

    GET /a/{domain}/api/det_export_instance/v1/

  • Read

    List fixture data

    List fixture data.

    GET /a/{domain}/api/fixture/v1/

  • Read

    Read fixture item

    Read fixture item.

    GET /a/{domain}/api/fixture/v1/{fixture_item_id}/

  • Read

    Download form attachment

    Download form attachment.

    GET /a/{domain}/api/form/attachment/{form_id}/{attachment_name}

  • Read

    List forms

    List forms.

    GET /a/{domain}/api/form/v1/

  • Read

    Read bulk form action status

    Read the status of an asynchronous form action job.

    GET /a/{domain}/api/form/v1/bulk-action/{id}/

  • Read

    Read form data

    Read form data.

    GET /a/{domain}/api/form/v1/{form_id}/

  • Read

    List groups

    List groups.

    GET /a/{domain}/api/group/v1/

  • Read

    Read group

    Read group.

    GET /a/{domain}/api/group/v1/{group_id}/

  • Read

    List locations v1

    List locations v1.

    GET /a/{domain}/api/location/v1/

  • Read

    Read location v1

    Read location v1.

    GET /a/{domain}/api/location/v1/{location_id}/

  • Read

    List locations v2

    List locations v2.

    GET /a/{domain}/api/location/v2/

  • Read

    Read location v2

    Read location v2.

    GET /a/{domain}/api/location/v2/{location_id}/

  • Read

    List location types

    List location types.

    GET /a/{domain}/api/location_type/v1/

  • Read

    Read location type

    Read location type.

    GET /a/{domain}/api/location_type/v1/{id}/

  • Read

    List messaging event records

    List messaging event records.

    GET /a/{domain}/api/messaging-event/v1/

  • Read

    List report configurations

    List report configurations.

    GET /a/{domain}/api/simplereportconfiguration/v1/

  • Read

    List mobile workers

    List mobile workers.

    GET /a/{domain}/api/user/v1/

  • Read

    Read mobile worker

    Read mobile worker.

    GET /a/{domain}/api/user/v1/{user_id}

  • Read

    List web users

    List web users.

    GET /a/{domain}/api/web-user/v1/

  • Read

    Read web user

    Read web user.

    GET /a/{domain}/api/web-user/v1/{user_id}

  • Read

    Read multimedia processing status

    Inspect the state of an asynchronous asset upload.

    GET /a/{domain}/apps/api/{app_id}/multimedia/status/{processing_id}/

  • Write

    Create or update cases

    Submit one or several case records.

    POST /a/{domain}/api/case/v2/

  • Write

    Upsert cases

    Create or update cases using external identifiers.

    PUT /a/{domain}/api/case/v2/

  • Write

    Upsert case by external identifier

    Create or update a case using its external identifier.

    PUT /a/{domain}/api/case/v2/ext/{external_id}/

  • Write

    Update case

    Update a case identified by its internal identifier.

    PUT /a/{domain}/api/case/v2/{case_id}

  • Write

    Create groups in bulk

    Create multiple groups in one request.

    PATCH /a/{domain}/api/group/v1/

  • Write

    Create group

    Create a project user group.

    POST /a/{domain}/api/group/v1/

  • Write

    Edit group

    Update a group and its member associations.

    PUT /a/{domain}/api/group/v1/{group_id}/

  • Write

    Invite web user

    Create an invitation for a web user to join a project.

    POST /a/{domain}/api/invitation/v1/

  • Write

    Create or update locations in bulk

    Submit a bulk location create/update payload.

    PATCH /a/{domain}/api/location/v2/

  • Write

    Create location

    Create a project location.

    POST /a/{domain}/api/location/v2/

  • Write

    Update location

    Edit an existing project location.

    PUT /a/{domain}/api/location/v2/{location_id}/

  • Write

    Create lookup table

    Create a lookup-table definition.

    POST /a/{domain}/api/lookup_table/v1/

  • Write

    Update lookup table

    Change a lookup-table definition.

    PUT /a/{domain}/api/lookup_table/v1/{lookup_table_id}/

  • Write

    Create lookup-table row

    Create a row in a lookup table.

    POST /a/{domain}/api/lookup_table_item/v1/

  • Write

    Update lookup-table row

    Change a lookup-table row.

    PUT /a/{domain}/api/lookup_table_item/v1/{lookup_table_item_id}/

  • Write

    Validate login credentials

    Validate a mobile-worker or web-user username and password and return the profile.

    POST /a/{domain}/api/sso/v1/

  • Write

    Create mobile worker

    Create a mobile worker account.

    POST /a/{domain}/api/user/v1/

  • Write

    Update mobile worker

    Update mobile-worker profile and access-related fields.

    PUT /a/{domain}/api/user/v1/{user_id}/

  • Write

    Email mobile-worker password reset

    Send a password-reset email to the selected mobile worker.

    POST /a/{domain}/api/user/v1/{user_id}/email_password_reset/

  • Write

    Edit web user

    Modify supported web-user properties.

    PATCH /a/{domain}/api/web-user/v1/{user_id}/

  • Write

    Activate web user

    Restore a web user to active status.

    POST /a/{domain}/api/web-user/v1/{user_id}/activate/

  • Write

    Import application

    Import application JSON; an existing app identifier can select an update.

    POST /a/{domain}/apps/api/import_app/

  • Write

    Upload application multimedia

    Upload a ZIP of multimedia assets for asynchronous processing.

    POST /a/{domain}/apps/api/{app_id}/multimedia/

  • Write

    Upload lookup-table spreadsheet

    Upload an Excel file to populate lookup tables.

    POST /a/{domain}/fixtures/fixapi/

  • Write

    Bulk import case spreadsheet

    Import or update case records using an Excel upload.

    POST /a/{domain}/importer/excel/bulk_upload_api/

  • Write

    Submit XForm

    Submit an OpenRosa XML form, either as multipart or raw XML.

    POST /a/{domain}/receiver/api/

  • Write

    Submit application-tagged XForm

    Submit an OpenRosa form tagged with an application identifier.

    POST /a/{domain}/receiver/{application_id}/

  • Destructive

    Apply bulk form action

    Queue archive, unarchive or delete actions for at most 5,000 form identifiers.

    POST /a/{domain}/api/form/v1/bulk-action/

  • Destructive

    Delete group

    Remove a project group.

    DELETE /a/{domain}/api/group/v1/{group_id}/

  • Destructive

    Delete lookup table

    Remove a lookup-table definition.

    DELETE /a/{domain}/api/lookup_table/v1/{lookup_table_id}/

  • Destructive

    Delete lookup-table row

    Remove a lookup-table row.

    DELETE /a/{domain}/api/lookup_table_item/v1/{lookup_table_item_id}/

  • Destructive

    Delete mobile worker

    Delete a mobile worker.

    DELETE /a/{domain}/api/user/v1/{user_id}/

  • Destructive

    Deactivate web user

    Disable a web user and revoke active access.

    POST /a/{domain}/api/web-user/v1/{user_id}/deactivate/

See How connections work for access and permissions, or browse all integrations.