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

Request Params

| 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":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","dept":"\u003cstring\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_client_version":"\u003cstring\u003e","last_login_time":"\u003cdateTime\u003e","last_name":"\u003cstring\u003e","pmi":"\u003clong\u003e","role_name":"\u003cstring\u003e","timezone":"\u003cstring\u003e","use_pmi":false,"display_name":"\u003cstring\u003e","account_id":"\u003cstring\u003e","account_number":"\u003clong\u003e","cms_user_id":"\u003cstring\u003e","company":"\u003cstring\u003e","user_created_at":"\u003cdateTime\u003e","custom_attributes":[{"key":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"employee_unique_id":"\u003cstring\u003e","group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"im_group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"jid":"\u003cstring\u003e","job_title":"\u003cstring\u003e","language":"\u003cstring\u003e","location":"\u003cstring\u003e","login_types":[24,99],"manager":"\u003cemail\u003e","personal_meeting_url":"\u003cstring\u003e","phone_country":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","phone_numbers":[{"code":"\u003cstring\u003e","country":"\u003cstring\u003e","label":"Home","number":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},{"code":"\u003cstring\u003e","country":"\u003cstring\u003e","label":"Mobile","number":"\u003cstring\u003e","verified":"\u003cboolean\u003e"}],"pic_url":"\u003cstring\u003e","plan_united_type":"16384","pronouns":"\u003cstring\u003e","pronouns_option":2,"role_id":"\u003cstring\u003e","status":"inactive","vanity_url":"\u003cstring\u003e","verified":"\u003cinteger\u003e","cluster":"\u003cstring\u003e","zoom_one_type":"\u003cinteger\u003e"}