Use this API to view a user’s information on a Zoom account. For user-level apps, pass the me value instead of the userId parameter.

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.

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

  • Note: The user_info:read scope is only available when you pass the me value for the $userId value.

Rate Limit Label: Light.

​
Parameters

ParameterDescription
Encrypted EmailWhether 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).
Login TypeThe 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)

The following login methods are only available in China:
* 11 — Phone number
* 21 — WeChat
* 23 — Alipay.
Search By Unique IDWhether 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).
User IDThe user ID or email address of the user. For user-level apps, pass the me value.

​
Example Output

{
	"id": "<string>",
	"first_name": "<string>",
	"last_name": "<string>",
	"display_name": "<string>",
	"email": "<string>",
	"type": 2,
	"role_name": "<string>",
	"pmi": 6401023003,
	"use_pmi": false,
	"personal_meeting_url": "<string>",
	"timezone": "<string>",
	"verified": 1,
	"dept": "<string>",
	"created_at": "2020-04-01T16:47:52Z",
	"last_login_time": "2020-04-01T16:47:52Z",
	"last_client_version": "<string>",
	"pic_url": "<string>",
	"cms_user_id": "<string>",
	"jid": "<string>",
	"group_ids": [],
	"im_group_ids": [],
	"account_id": "<string>",
	"language": "<string>",
	"phone_country": "<string>",
	"phone_number": "<string>",
	"status": "<string>",
	"job_title": "<string>",
	"cost_center": "<string>",
	"location": "<string>",
	"login_types": [
		0
	],
	"role_id": "<string>",
	"cluster": "<string>",
	"user_created_at": "2020-04-01T16:47:52Z"
}

​
Workflow Library Example

Setting Up an Incident Process

Preview this Workflow on desktop