Delphi (DLL) / Zoom API / List IM directory groups
Back to Collection Items
var
begin
CkHttp_putAuthToken(http,'<access_token>');success := CkHttp_QuickGetSb(http,'https://api.zoom.us/v2/im/groups',sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);id := CkJsonObject__stringOf(jResp,'groups[i].id');name := CkJsonObject__stringOf(jResp,'groups[i].name');total_members := CkJsonObject__stringOf(jResp,'groups[i].total_members');v_type := CkJsonObject__stringOf(jResp,'groups[i].type');search_by_domain := CkJsonObject__stringOf(jResp,'groups[i].search_by_domain');search_by_account := CkJsonObject__stringOf(jResp,'groups[i].search_by_account');search_by_ma_account := CkJsonObject__stringOf(jResp,'groups[i].search_by_ma_account');i := i + 1;
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/im/groups
Postman Collection Item JSON
{
"name": "List IM directory groups",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/im/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups"
]
},
"description": "List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br>\n**Scopes**: `imgroup:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `200` <br>\nList of groups returned.\n**Error Code:** `200` <br>\nList of IM groups returned.<br>\nOnly available for paid account:{accountId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/im/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page_count\": \"1\",\n \"page_number\": \"1\",\n \"page_size\": \"1\",\n \"total_records\": \"1\",\n \"groups\": [\n {\n \"id\": \"sjvfkjfew34535\",\n \"name\": \"MyAdminDirectoryGroup\",\n \"total_members\": \"10\",\n \"type\": \"shared\",\n \"search_by_domain\": \"true\",\n \"search_by_account\": \"false\",\n \"search_by_ma_account\": \"false\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404` <br>\n**Error Code:** `4130` <br>\nGroup does not exist:{groupId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/im/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}