TCL / Zoom API / List users
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "status" "active"
CkJsonObject_UpdateInt $queryParams "page_size" 30
CkJsonObject_UpdateString $queryParams "role_id" "quis officia in reprehenderit"
CkJsonObject_UpdateString $queryParams "page_number" "quis officia in reprehenderit"
CkJsonObject_UpdateString $queryParams "include_fields" "custom_attributes"
CkJsonObject_UpdateString $queryParams "next_page_token" "quis officia in reprehenderit"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.zoom.us/v2/users" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "page_count": 1,
# "page_number": 1,
# "page_size": 30,
# "total_records": 1,
# "users": [
# {
# "id": "z8yAAAAA8bbbQ",
# "first_name": "Taylor",
# "last_name": "Kim",
# "email": "example@example.com",
# "type": 2,
# "pmi": 111111111,
# "timezone": "America/Los_Angeles",
# "verified": 1,
# "dept": "",
# "created_at": "2018-11-15T01:10:08Z",
# "last_login_time": "2019-09-13T21:08:52Z",
# "last_client_version": "4.4.55383.0716(android)",
# "pic_url": "https://example.com/photo.jpg",
# "im_group_ids": [
# "GroupName"
# ],
# "status": "active",
# "employee_unique_id": "dddaaaa"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set page_count [CkJsonObject_IntOf $jResp "page_count"]
set page_number [CkJsonObject_IntOf $jResp "page_number"]
set page_size [CkJsonObject_IntOf $jResp "page_size"]
set total_records [CkJsonObject_IntOf $jResp "total_records"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "users"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "users[i].id"]
set first_name [CkJsonObject_stringOf $jResp "users[i].first_name"]
set last_name [CkJsonObject_stringOf $jResp "users[i].last_name"]
set email [CkJsonObject_stringOf $jResp "users[i].email"]
set v_type [CkJsonObject_IntOf $jResp "users[i].type"]
set pmi [CkJsonObject_IntOf $jResp "users[i].pmi"]
set timezone [CkJsonObject_stringOf $jResp "users[i].timezone"]
set verified [CkJsonObject_IntOf $jResp "users[i].verified"]
set dept [CkJsonObject_stringOf $jResp "users[i].dept"]
set created_at [CkJsonObject_stringOf $jResp "users[i].created_at"]
set last_login_time [CkJsonObject_stringOf $jResp "users[i].last_login_time"]
set last_client_version [CkJsonObject_stringOf $jResp "users[i].last_client_version"]
set pic_url [CkJsonObject_stringOf $jResp "users[i].pic_url"]
set status [CkJsonObject_stringOf $jResp "users[i].status"]
set employee_unique_id [CkJsonObject_stringOf $jResp "users[i].employee_unique_id"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "users[i].im_group_ids"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "users[i].im_group_ids[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "status=active"
-d "page_size=30"
-d "role_id=quis%20officia%20in%20reprehenderit"
-d "page_number=quis%20officia%20in%20reprehenderit"
-d "include_fields=custom_attributes"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users
Postman Collection Item JSON
{
"name": "List users",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users?status=active&page_size=30&role_id=quis officia in reprehenderit&page_number=quis officia in reprehenderit&include_fields=custom_attributes&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [
{
"key": "status",
"value": "active",
"description": "The user's status: \n* `active` — An active user. \n* `inactive` — A deactivated user. \n* `pending` — A pending user.\n\nThis value defaults to `active`."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "role_id",
"value": "quis officia in reprehenderit",
"description": "The role's unique ID. Use this parameter to filter the response by a specific role. You can use the [List Roles](https://marketplace.zoom.us/docs/api-reference/zoom-api/roles/roles) API to get a role's unique ID value."
},
{
"key": "page_number",
"value": "quis officia in reprehenderit",
"description": "The page number of the current page in the returned records."
},
{
"key": "include_fields",
"value": "custom_attributes",
"description": "Use this parameter to display one of the following attributes in the API call's response: \n* `custom_attributes` — Return the user's custom attributes. \n* `host_key` — Return the user's [host key](https://support.zoom.us/hc/en-us/articles/205172555-Using-your-host-key)."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
]
},
"description": "Use this API to list your account's users. \n\n**Scopes:** `user:read:admin` \n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nUser list returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users?status=active&page_size=30&role_id=quis officia in reprehenderit&page_number=quis officia in reprehenderit&include_fields=custom_attributes&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [
{
"key": "status",
"value": "active"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "role_id",
"value": "quis officia in reprehenderit"
},
{
"key": "page_number",
"value": "quis officia in reprehenderit"
},
{
"key": "include_fields",
"value": "custom_attributes"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"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\": 30,\n \"total_records\": 1,\n \"users\": [\n {\n \"id\": \"z8yAAAAA8bbbQ\",\n \"first_name\": \"Taylor\",\n \"last_name\": \"Kim\",\n \"email\": \"example@example.com\",\n \"type\": 2,\n \"pmi\": 111111111,\n \"timezone\": \"America/Los_Angeles\",\n \"verified\": 1,\n \"dept\": \"\",\n \"created_at\": \"2018-11-15T01:10:08Z\",\n \"last_login_time\": \"2019-09-13T21:08:52Z\",\n \"last_client_version\": \"4.4.55383.0716(android)\",\n \"pic_url\": \"https://example.com/photo.jpg\",\n \"im_group_ids\": [\n \"GroupName\"\n ],\n \"status\": \"active\",\n \"employee_unique_id\": \"dddaaaa\"\n }\n ]\n}"
}
]
}
