PHP (Extension) / Zoom API / List IM directory groups
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
$http->put_AuthToken('<access_token>');$success = $http->QuickGetSb('https://api.zoom.us/v2/im/groups',$sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$jResp->put_I($i);$id = $jResp->stringOf('groups[i].id');$name = $jResp->stringOf('groups[i].name');$total_members = $jResp->stringOf('groups[i].total_members');$v_type = $jResp->stringOf('groups[i].type');$search_by_domain = $jResp->stringOf('groups[i].search_by_domain');$search_by_account = $jResp->stringOf('groups[i].search_by_account');$search_by_ma_account = $jResp->stringOf('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": ""
}
]
}