CommCare APIs
CommCare APIs provide access to various system functionalities, including data retrieval, case and form submissions, and user management. This page describes different APIs available for integration.
Note
This feature requires a CommCare Software Plan
This feature is only available to CommCare users with a Standard Plan or above. For more details, please see the CommCare Pricing Overview
Table of contents
Data APIs
These APIs are intended for building project-specific applications and integrations, including:
Custom end-user applications that address project-specific needs.
Custom integrations with external back-end systems, such as an electronic patient record system.
You can browse and test the Data APIs using the CommCare API Explorer.
Implementation of URL Endpoints - All URL endpoints should be utilized as part of a cURL authentication command. For more information, please review CommCare’s API Authentication Documentation: API Authentication.
- Application Structure API
- Form Data API
- Form Attachments
- Case Data API
- Bulk Upload Case Data API
- List Cases (Version 0.3+)
- List Forms
- List Groups
- List Mobile Workers
- List Web Users
- Bulk User Resource
- List Reports
- Download Report Data
- Location APIs
- Fixture Data APIs (or Lookup Tables)
- Bulk Upload Lookup Tables
- Lookup Table Individual API
- Lookup Table Rows API
- OTA API Restore
User APIs
The User APIs provide endpoints for managing mobile and web users, including creation, editing, deletion, and authentication. These APIs also support group management, Single Sign-On, and user identity verification.
Form Submission API
CommCare’s Submission API implements the OpenRosa standard Form Submission API for submitting XForms over HTTP/S.
SMS APIs
SMS APIs enable sending and receiving SMS messages through CommCare, allowing integration with external systems for automated messaging, notifications, and data collection. These APIs support message scheduling, two-way communication, and customization based on workflow needs.