get

/users/{userId}

A Zoom account can have one or more users. Use this API to view information of a specific user on a Zoom account.

Scopes: user:read:admin user:read

Note: If a user's status is pending, only `id` and `created_at` fields will be returned. The value of `created_at` will be the time at which the API call was made until the user activates their account.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
1 Query Parameter

Responses

HTTP Status Code: 200
User object returned.

1 Example
Schema
object

The user object represents a specific user on Zoom.

id
string

User ID.

first_name
string

User’s first name.

1 validation
last_name
string

User’s last name.

1 validation
email
string

User’s email address.

1 validation + required
type
integer

User’s plan type:
1 - Basic.
2 - Pro.
3 - Corp.

2 validations + required
role_name
string

User’s role name.

pmi
integer

Personal meeting ID.

use_pmi
boolean

Use Personal Meeting ID for instant meetings.

1 validation
timezone
string

The time zone of the user.

dept
string

Department.

created_at
string

User create time.

1 validation
last_login_time
string

User last login time.

1 validation
last_client_version
string

User last login client version.

language
string

Default language for the Zoom Web Portal.

phone_country
string

User’s country for Company Phone Number.

phone_number
string

User’s phone number.

vanity_url
string

Personal meeting room URL, if the user has one.

personal_meeting_url
string

User’s personal meeting url.

verified
integer

Displays whether user is verified or not.
1 - Account verified.
0 - Account not verified.

pic_url
string

The URL for user’s profile picture.

cms_user_id
string

CMS ID of user, only enabled for Kaltura integration.

account_id
string

User’s account ID.

host_key
string

User’s host key.

status
string

Status of user’s account.

2 validations
group_ids
array[string]

IDs of the web groups user belongs to.

im_group_ids
array[string]

IM IDs of the groups user belongs to.

jid
string

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
userId
$$.env
1 variable not set
oauth_access_token