delphiDll / Zoom API / Get a user
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
key: PWideChar;
name: PWideChar;
value: PWideChar;
strVal: PWideChar;
created_at: PWideChar;
id: PWideChar;
first_name: PWideChar;
last_name: PWideChar;
email: PWideChar;
v_type: Integer;
role_name: PWideChar;
pmi: Integer;
use_pmi: Boolean;
personal_meeting_url: PWideChar;
timezone: PWideChar;
verified: Integer;
dept: PWideChar;
last_login_time: PWideChar;
last_client_version: PWideChar;
pic_url: PWideChar;
host_key: PWideChar;
jid: PWideChar;
account_id: PWideChar;
language: PWideChar;
phone_country: PWideChar;
phone_number: PWideChar;
status: PWideChar;
role_id: PWideChar;
employee_unique_id: PWideChar;
account_number: Integer;
manager: PWideChar;
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_UpdateInt(queryParams,'login_type',100);
CkJsonObject_UpdateString(queryParams,'encrypted_email','true');
CkJsonObject_UpdateString(queryParams,'search_by_unique_id','true');
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.zoom.us/v2/users/:userId',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)
// {
// "created_at": "2018-11-15T01:10:08Z",
// "custom_attributes": [
// {
// "key": "cb3674544gexq",
// "name": "Country of Citizenship",
// "value": "Nepal"
// }
// ],
// "id": "z8dsdsdsdsdCfp8uQ",
// "first_name": "Harry",
// "last_name": "Grande",
// "email": "example@example.com",
// "type": 2,
// "role_name": "Owner",
// "pmi": 100000000,
// "use_pmi": false,
// "personal_meeting_url": "https://zoom.us/j/6352635623323434343443",
// "timezone": "America/Los_Angeles",
// "verified": 1,
// "dept": "",
// "last_login_time": "2019-09-13T21:08:52Z",
// "last_client_version": "4.4.55383.0716(android)",
// "pic_url": "https://lh4.googleusercontent.com/-hsgfhdgsfghdsfghfd-photo.jpg",
// "host_key": "0000",
// "jid": "hghghfghdfghdfhgh@xmpp.zoom.us",
// "group_ids": [
// ],
// "im_group_ids": [
// "CcSAAAAAAABBBVoQ"
// ],
// "account_id": "EAAAAAbbbbbCCCCHMA",
// "language": "en-US",
// "phone_country": "USA",
// "phone_number": "15550100",
// "status": "active",
// "role_id": "hdsfwyteg3675hgfs",
// "employee_unique_id": "dddaaaa",
// "account_number": 20212021,
// "manager": "name@example.com"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
created_at := CkJsonObject__stringOf(jResp,'created_at');
id := CkJsonObject__stringOf(jResp,'id');
first_name := CkJsonObject__stringOf(jResp,'first_name');
last_name := CkJsonObject__stringOf(jResp,'last_name');
email := CkJsonObject__stringOf(jResp,'email');
v_type := CkJsonObject_IntOf(jResp,'type');
role_name := CkJsonObject__stringOf(jResp,'role_name');
pmi := CkJsonObject_IntOf(jResp,'pmi');
use_pmi := CkJsonObject_BoolOf(jResp,'use_pmi');
personal_meeting_url := CkJsonObject__stringOf(jResp,'personal_meeting_url');
timezone := CkJsonObject__stringOf(jResp,'timezone');
verified := CkJsonObject_IntOf(jResp,'verified');
dept := CkJsonObject__stringOf(jResp,'dept');
last_login_time := CkJsonObject__stringOf(jResp,'last_login_time');
last_client_version := CkJsonObject__stringOf(jResp,'last_client_version');
pic_url := CkJsonObject__stringOf(jResp,'pic_url');
host_key := CkJsonObject__stringOf(jResp,'host_key');
jid := CkJsonObject__stringOf(jResp,'jid');
account_id := CkJsonObject__stringOf(jResp,'account_id');
language := CkJsonObject__stringOf(jResp,'language');
phone_country := CkJsonObject__stringOf(jResp,'phone_country');
phone_number := CkJsonObject__stringOf(jResp,'phone_number');
status := CkJsonObject__stringOf(jResp,'status');
role_id := CkJsonObject__stringOf(jResp,'role_id');
employee_unique_id := CkJsonObject__stringOf(jResp,'employee_unique_id');
account_number := CkJsonObject_IntOf(jResp,'account_number');
manager := CkJsonObject__stringOf(jResp,'manager');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'custom_attributes');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
key := CkJsonObject__stringOf(jResp,'custom_attributes[i].key');
name := CkJsonObject__stringOf(jResp,'custom_attributes[i].name');
value := CkJsonObject__stringOf(jResp,'custom_attributes[i].value');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'group_ids');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'im_group_ids');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'im_group_ids[i]');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -G -d "login_type=100"
-d "encrypted_email=true"
-d "search_by_unique_id=true"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users/:userId
Postman Collection Item JSON
{
"name": "Get a user",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userId?login_type=100&encrypted_email=true&search_by_unique_id=true",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId"
],
"query": [
{
"key": "login_type",
"value": "100",
"description": "The user's login method:\n\n`0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)\n\nThe following login methods are only available in China:\n\n`11` — Phone number</br>`21` — WeChat</br>`23` — Alipay"
},
{
"key": "encrypted_email",
"value": "true",
"description": "Whether the email address passed for the `userId` value is an encrypted email address:\n\n* `true` — The email address is encrypted.\n* `false` — The email address is not encrypted.\n\nIf you do not query this parameter, this value defaults to null (`false`)."
},
{
"key": "search_by_unique_id",
"value": "true",
"description": "Whether the queried `userId` value is an employee unique ID: \n* `true` — The queried ID is an employee's unique ID. \n* `false` — The queried ID is not an employee's unique ID. \n\nThis value defaults to `false` (null)."
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
},
"description": "Use this API to view a user's information on a Zoom account. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n**Note:** Users who have not activated their account will have a `pending` status. These users' `created_at` timestamp will also display the time at which the API call was made, **not** the account's creation date. \n\n**Scopes:** `user:read:admin`, `user:read`, `user_info:read` <br> \n* **Note:** The `user_info:read` scope is only available when you pass the `me` value for the `$userId` value. \n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nUser object returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId?login_type=100&encrypted_email=true&search_by_unique_id=true",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "encrypted_email",
"value": "true"
},
{
"key": "search_by_unique_id",
"value": "true"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"created_at\": \"2018-11-15T01:10:08Z\",\n \"custom_attributes\": [\n {\n \"key\": \"cb3674544gexq\",\n \"name\": \"Country of Citizenship\",\n \"value\": \"Nepal\"\n }\n ],\n \"id\": \"z8dsdsdsdsdCfp8uQ\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Grande\",\n \"email\": \"example@example.com\",\n \"type\": 2,\n \"role_name\": \"Owner\",\n \"pmi\": 100000000,\n \"use_pmi\": false,\n \"personal_meeting_url\": \"https://zoom.us/j/6352635623323434343443\",\n \"timezone\": \"America/Los_Angeles\",\n \"verified\": 1,\n \"dept\": \"\",\n \"last_login_time\": \"2019-09-13T21:08:52Z\",\n \"last_client_version\": \"4.4.55383.0716(android)\",\n \"pic_url\": \"https://lh4.googleusercontent.com/-hsgfhdgsfghdsfghfd-photo.jpg\",\n \"host_key\": \"0000\",\n \"jid\": \"hghghfghdfghdfhgh@xmpp.zoom.us\",\n \"group_ids\": [],\n \"im_group_ids\": [\n \"CcSAAAAAAABBBVoQ\"\n ],\n \"account_id\": \"EAAAAAbbbbbCCCCHMA\",\n \"language\": \"en-US\",\n \"phone_country\": \"USA\",\n \"phone_number\": \"15550100\",\n \"status\": \"active\",\n \"role_id\": \"hdsfwyteg3675hgfs\",\n \"employee_unique_id\": \"dddaaaa\",\n \"account_number\": 20212021,\n \"manager\": \"name@example.com\"\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\nBad request<br>\n**Error Code:** `1120`<br>\nA valid invitation to join the Zoom account was not found for this user. <br>\nThis error is thrown if you added a user in your account but the user did not accept t",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId?login_type=100&encrypted_email=true&search_by_unique_id=true",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "encrypted_email",
"value": "true"
},
{
"key": "search_by_unique_id",
"value": "true"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br>\n**Error Code:** `1001`<br>\nUser does not exist: $userId.<br>",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId?login_type=100&encrypted_email=true&search_by_unique_id=true",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "encrypted_email",
"value": "true"
},
{
"key": "search_by_unique_id",
"value": "true"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
