...
API | Description | URL Endpoint | Permission required |
|---|---|---|---|
API to submit data to CommCare HQ. | See Documentation | Set per domain | |
| Bulk Upload API | Performs Bulk Imports of Case Data through the Excel Case Data Importer to either create or update cases | See Documentation | Valid login |
| User Creation (Mobile Worker) | API to create a mobile worker on CommCare HQ | https://www.commcarehq.org/a/[domain]/api/[version]/user/ | Edit Mobile Workers |
| User Edit (Mobile Worker) | API to edit a mobile worker on CommCare HQ | https://www.commcarehq.org/a/[domain]/api/[version]/user/[id] | Edit Mobile Workers |
| User Delete (Mobile Worker) | API to delete a mobile worker on CommCare HQ | https://www.commcarehq.org/a/[domain]/api/[version]/user/[id] | Edit Mobile Workers |
API for registering users on CommCare HQ. | https://www.commcarehq.org/a/\[domain\]/receiver | Set per domain | |
API to retrieve data payload consumable to restore a users current state of cases. | See Documentation | Valid login | |
API to export data from CommCare HQ. | See Documentation | Set per domain | |
List, create, edit and delete groups | See Documentation | Edit Mobile Workers | |
list mobile workers or access individual user data | https://www.commcarehq.org/a/[domain]/api/[version]/user/ | Edit Mobile Workers | |
| list web users or access individual user data | http://www.commcarehq.org/a/[domain]/api/ [version] /web-user/ | Edit Web Users | |
| List locations and location types and view their details | See documentation | Valid login | |
| SMS Mobile Worker Registration API | API to initiate the SMS Mobile Worker Registration workflow | https://www.commcarehq.org/a/[domain]/api/[version]/sms_user_registration/ | Edit Data |
| Send CommCare Install Info over SMS | API to facilitate the reinstallation of CommCare for already-registered users | https://www.commcarehq.org/a/[domain]/api/[version]/sms_user_registration_reinstall/ | Edit Data |
list cases | 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 APIs | list/search forms or access a single form | https://www.commcarehq.org/a/[domain]/api/[version]/form/[form_id]/ | Edit Data |
| Application Structure | view the schema of modules, cases, and forms for your application | https://www.commcarehq.org/a/[domain]/api/[version]/application/ | Edit Apps |
| User Identity | Look up user details | https://www.commcarehq.org/api/[version]/identity/ | Valid login |
| User Domain List | Look up user domains | https://www.commcarehq.org/api/[version]/user_domains/ | Valid login |
| Single Sign On | check login credentials and get the user details | https://www.commcarehq.org/a/[domain]/api/[version]/sso/ | Valid login |
| Form Attachments | API to get an attachment from a form | https://www.commcarehq.org/a/[domain]/api/form/attachment/{form_id}/{attachment_name} | Valid login |
| Case Attachments | API to get an attachment from a case | https://www.commcarehq.org/a/[domain]/api/case/attachment/{form_id}/{ attachment_name} | Valid login |
| Lookup Table Download | Get lookup table data | See documentation | Edit Apps |
| Lookup Table Upload | Create or edit lookup tables by uploading excel file containing table data | See documentation | Edit Apps |
| Download a .ccz file | Download the .ccz file for a specific version of an application | See documentation | |
| List Reports | List the available reports in the project | https://www.commcarehq.org/a/[PROJECT]/api/v0.5/simplereportconfiguration/?format=json | Domain Admin |
| Download Report Data | Filter and download data for a specific report | https://www.commcarehq.org/a/[PROJECT]/api/v0.5/configurablereportdata/REPORTID/ | View Data |
...