Zoom Public API Documentation
Get a user
GET {{baseUrl}}/users/:userId?login_type=99&encrypted_email=false&search_by_unique_id=<boolean>
View a user's information on a Zoom account. For user-managed apps, pass the Users who have not activated their account will have a Scopes: Rate Limit Label: me value instead of the userId parameter.
Note: The user_info:read scope is only available when you pass the me value for the $userId value. 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. user_info:read,user:read,user:read:adminLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
login_type
|
number | The user's login method. * `0` - Facebook OAuth * `1` - Google OAuth. * `24` - Apple OAuth. * `27` - Microsoft OAuth. * `97` - Mobile device. * `98` - RingCentral OAuth. * `99` - API user. * `100` - Zoom Work email. * `101` - Single Sign-On (SSO). These login methods are only available in China. * `11` - Phone number. * `21` - WeChat. * `23` - Alipay. | |
encrypted_email
|
boolean | Whether the email address passed for the `userId` value is an encrypted email address. * `true` - The email address is encrypted. * `false` - The email address is not encrypted. If you do not query this parameter, this value defaults to null (`false`). | |
search_by_unique_id
|
string | Whether the queried `userId` value is an employee unique ID. * `true` - The queried ID is an employee's unique ID. * `false` - The queried ID is not an employee's unique ID. This value defaults to `false` (null). |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"type": 2,
"id": "<string>",
"created_at": "<dateTime>",
"dept": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_client_version": "<string>",
"last_login_time": "<dateTime>",
"last_name": "<string>",
"pmi": "<long>",
"role_name": "<string>",
"timezone": "<string>",
"use_pmi": false,
"display_name": "<string>",
"account_id": "<string>",
"account_number": "<long>",
"cms_user_id": "<string>",
"company": "<string>",
"user_created_at": "<dateTime>",
"custom_attributes": [
{
"key": "<string>",
"name": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"name": "<string>",
"value": "<string>"
}
],
"employee_unique_id": "<string>",
"group_ids": [
"<string>",
"<string>"
],
"im_group_ids": [
"<string>",
"<string>"
],
"jid": "<string>",
"job_title": "<string>",
"language": "<string>",
"location": "<string>",
"login_types": [
24,
99
],
"manager": "<email>",
"personal_meeting_url": "<string>",
"phone_country": "<string>",
"phone_number": "<string>",
"phone_numbers": [
{
"code": "<string>",
"country": "<string>",
"label": "Home",
"number": "<string>",
"verified": "<boolean>"
},
{
"code": "<string>",
"country": "<string>",
"label": "Mobile",
"number": "<string>",
"verified": "<boolean>"
}
],
"pic_url": "<string>",
"plan_united_type": "16384",
"pronouns": "<string>",
"pronouns_option": 2,
"role_id": "<string>",
"status": "inactive",
"vanity_url": "<string>",
"verified": "<integer>",
"cluster": "<string>",
"zoom_one_type": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/users/:userId?login_type=99&encrypted_email=false&search_by_unique_id=<boolean>?login_type=99&encrypted_email=false&search_by_unique_id=<boolean>' -H 'Accept: application/json'
ENDPOINTS