This feature requires a CommCare Software Plan
This feature (API Access) is only available to CommCare users with a Standard Plan or higher. For more details, see the CommCare Software Plan page.
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
In the following, [version] should always be replaced with one of v0.4, v0.3, etc. These documents only describe the latest version - prior versions remain available only to support backwards compatibility with deployed systems, not for general use. The latest version is v0.5.
API | Description | URL Endpoint | Permission required | Status |
|---|---|---|---|---|
list groups | https://www.commcarehq.org/a/[domain]/api/[version]/group/ | Edit Mobile Workers | ✓ | |
list users | https://www.commcarehq.org/a/[domain]/api/[version]/user/ | Edit Mobile Workers | ✓ | |
list cases | https://www.commcarehq.org/a/[domain]/api/[version]/case/ | Edit Data | ✓ | |
find a single case | https://www.commcarehq.org/a/[domain]/api/[version]/case/[case_id]/ | Edit Data | ✓ | |
| Forms | list form submissions | https://www.commcarehq.org/a/[domain]/api/[version]/form/ | Edit Data | ✓ |
| Form Data | find a single form | https://www.commcarehq.org/a/[domain]/api/[version]/forms/[form_id]/ | Edit Data | ✓ |
| Fixture Data | find a single fixture | https://www.commcarehq.org/a/[domain]/api/[version]/fixture/[fixture_id]/ | Edit Apps | ✓ |
| Single Sign On | check login credentials | https://www.commcarehq.org/a/[domain]/api/[version]/sso/ | Valid Login | ✓ |
