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 requiredStatus

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

find a single case

https://www.commcarehq.org/a/[domain]/api/[version]/case/[case_id]/

Edit Data
Formslist form submissionshttps://www.commcarehq.org/a/[domain]/api/[version]/form/Edit Data
Form Datafind a single formhttps://www.commcarehq.org/a/[domain]/api/[version]/forms/[form_id]/Edit Data
Fixture Datafind a single fixturehttps://www.commcarehq.org/a/[domain]/api/[version]/fixture/[fixture_id]/Edit Apps
Single Sign Oncheck login credentialshttps://www.commcarehq.org/a/[domain]/api/[version]/sso/Valid Login
  • No labels