...
...
...
...
...
...
...
...
...
...
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
API Authentication All URL endpoints should be utilized as part of a cURL authentication command. For more information, please review https://dimagi.atlassian.net/wiki/x/LwXKfw. |
List Groups
URL: https://www.commcarehq.org/a/[domain]/api/[version]/group/
...
| Code Block | ||
|---|---|---|
| ||
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"case_sharing": false,
"domain": "cloudcaredemo",
"id": "1eb59d6938fc7e510254d8c2f63d944f",
"metadata": {},
"name": "Wozzle",
"path": [],
"reporting": true,
"users": ["91da6b1c78699adfb8679b741caf9f00", "8a642f722c9e617eeed29290e409fcd5"]
},
...
]
}
|
Bulk API
URL: https://www.commcarehq.org/a/[domain]/api/[version]/group/
Supported Methods:
Method | Description |
|---|---|
POST | Create group |
PATCH | Create multiple groups |
...
| Code Block | ||
|---|---|---|
| ||
{
"objects": [
{
"case_sharing": false,
"name": "Test 1",
"reporting": true
},
{
"case_sharing": true,
"name": "Test 2",
"reporting": true
}
]
} |
Individual API
URL: https://www.commcarehq.org/a/[domain]/api/[version]/group/[group id]
Supported Methods:
Method | Description |
|---|---|
GET | Get group |
PUT | Edit group |
DELETE | Delete group |
...