Logo
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 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.

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.

Scopes: user_info:read,user:read,user:read:admin

Rate Limit Label: LIGHT

 

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

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