delphiDll / Zoom API / List users
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
first_name: PWideChar;
last_name: PWideChar;
email: PWideChar;
v_type: Integer;
pmi: Integer;
timezone: PWideChar;
verified: Integer;
dept: PWideChar;
created_at: PWideChar;
last_login_time: PWideChar;
last_client_version: PWideChar;
pic_url: PWideChar;
status: PWideChar;
employee_unique_id: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
page_count: Integer;
page_number: Integer;
page_size: Integer;
total_records: Integer;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
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_putAuthToken(http,'<access_token>');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.zoom.us/v2/users',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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
page_count := CkJsonObject_IntOf(jResp,'page_count');
page_number := CkJsonObject_IntOf(jResp,'page_number');
page_size := CkJsonObject_IntOf(jResp,'page_size');
total_records := CkJsonObject_IntOf(jResp,'total_records');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'users');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'users[i].id');
first_name := CkJsonObject__stringOf(jResp,'users[i].first_name');
last_name := CkJsonObject__stringOf(jResp,'users[i].last_name');
email := CkJsonObject__stringOf(jResp,'users[i].email');
v_type := CkJsonObject_IntOf(jResp,'users[i].type');
pmi := CkJsonObject_IntOf(jResp,'users[i].pmi');
timezone := CkJsonObject__stringOf(jResp,'users[i].timezone');
verified := CkJsonObject_IntOf(jResp,'users[i].verified');
dept := CkJsonObject__stringOf(jResp,'users[i].dept');
created_at := CkJsonObject__stringOf(jResp,'users[i].created_at');
last_login_time := CkJsonObject__stringOf(jResp,'users[i].last_login_time');
last_client_version := CkJsonObject__stringOf(jResp,'users[i].last_client_version');
pic_url := CkJsonObject__stringOf(jResp,'users[i].pic_url');
status := CkJsonObject__stringOf(jResp,'users[i].status');
employee_unique_id := CkJsonObject__stringOf(jResp,'users[i].employee_unique_id');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'users[i].im_group_ids');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'users[i].im_group_ids[j]');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
}
]
}
