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.

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	Description	URL Endpoint	Permission required

API	Description	URL Endpoint	Permission required
Groups	list groups	https://www.commcarehq.org/a/[domain]/api/[version]/group/	Edit Mobile Workers
Users	list users	https://www.commcarehq.org/a/[domain]/api/[version]/user/	Edit Mobile Workers
Cases	list cases	https://www.commcarehq.org/a/[domain]/api/[version]/case/	Edit Data
Case Data APIs	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 APIs	find a single form	https://www.commcarehq.org/a/[domain]/api/[version]/forms/[form_id]/	Edit Data
https://dimagi.atlassian.net/wiki/spaces/commcarepublic/pages/2143957453	find a single fixture	https://www.commcarehq.org/a/[domain]/api/[version]/fixture/[fixture_id]/	Edit Apps