Popular Help Content

No popular content.

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added Location API docs




URL Endpoint

Permission required


API to submit data to CommCare HQ.

See Documentation

Set per domain
Bulk Upload APIPerforms Bulk Imports of Case Data through the Excel Case Data Importer to either create or update casesSee DocumentationValid login
User Creation (Mobile Worker)API to create a mobile worker on CommCare HQhttps://www.commcarehq.org/a/[domain]/api/[version]/user/Edit Mobile Workers
User Edit (Mobile Worker)API to edit a mobile worker on CommCare HQhttps://www.commcarehq.org/a/[domain]/api/[version]/user/[idEdit Mobile Workers
User Delete (Mobile Worker)API to delete a mobile worker on CommCare HQhttps://www.commcarehq.org/a/[domain]/api/[version]/user/[id]Edit Mobile Workers

User Registration

API for registering users on CommCare HQ.


Set per domain

OTA Restore (Case List)

API to retrieve data payload consumable to restore a users current state of cases.

See Documentation

Valid login

Data Export

API to export data from CommCare HQ.

See Documentation

Set per domain


List, create, edit and delete groups

See Documentation

Edit Mobile Workers

Mobile Workers

list mobile workers or access individual user data


Edit Mobile Workers

Web Users

list web users or access individual user datahttp://www.commcarehq.org/a/[domain]/api/ [version] /web-user/Edit Web Users


List locations and location types and view their detailsSee documentationValid login
SMS Mobile Worker Registration APIAPI to initiate the SMS Mobile Worker Registration workflowhttps://www.commcarehq.org/a/[domain]/api/[version]/sms_user_registration/Edit Data
Send CommCare Install Info over SMSAPI to facilitate the reinstallation of CommCare for already-registered usershttps://www.commcarehq.org/a/[domain]/api/[version]/sms_user_registration_reinstall/Edit Data


list cases


Edit Data

Case Data

find a single case


Edit Data
Formslist form submissionshttps://www.commcarehq.org/a/[domain]/api/[version]/form/Edit Data
Form Datalist/search forms or access a single formhttps://www.commcarehq.org/a/[domain]/api/[version]/form/[form_id]/Edit Data
Application Structureview the schema of modules, cases, and forms for your applicationhttps://www.commcarehq.org/a/[domain]/api/[version]/application/Edit Apps
User IdentityLook up user detailshttps://www.commcarehq.org/api/[version]/identity/Valid login
User Domain ListLook up user domainshttps://www.commcarehq.org/api/[version]/user_domains/Valid login
Single Sign Oncheck login credentials and get the user detailshttps://www.commcarehq.org/a/[domain]/api/[version]/sso/Valid login
Form AttachmentsAPI to get an attachment from a formhttps://www.commcarehq.org/a/[domain]/api/form/attachment/{form_id}/{attachment_name}Valid login
Case AttachmentsAPI to get an attachment from a casehttps://www.commcarehq.org/a/[domain]/api/case/attachment/{form_id}/{ attachment_name}Valid login
Lookup Table DownloadGet lookup table dataSee documentationEdit Apps
Lookup Table UploadCreate or edit lookup tables by uploading excel file containing table dataSee documentationEdit Apps
Download a .ccz fileDownload the .ccz file for a specific version of an applicationSee documentation
List ReportsList the available reports in the projecthttps://www.commcarehq.org/a/[PROJECT]/api/v0.5/simplereportconfiguration/?format=jsonDomain Admin
Download Report DataFilter and download data for a specific reporthttps://www.commcarehq.org/a/[PROJECT]/api/v0.5/configurablereportdata/REPORTID/View Data