Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Account
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Settings
Setting Templates
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Video SDK Events
Zoom Room Events
Deprecated API Endpoints
get

/users/{userId}

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

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
3 Query Parameters

Responses

HTTP Status Code: 200 OK
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.

required
type
integer

User’s plan type:
1 - Basic.
2 - Licensed.
3 - On-prem.
99 - None (this can only be set with ssoCreate).

1 validation + required
role_name
string

User’s role name.

pmi
integer

Personal meeting ID.

1 validation
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

Note: This field has been deprecated and will not be supported in the future. Use the phone_numbers field instead of this field.
User’s country for Company Phone Number.

phone_number
string

Note: This field has been deprecated and will not be supported in the future. Use the phone_numbers field instead of this field.
User’s phone number.

phone_numbers
array[object]
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
job_title
string

User’s job title.

company
string

User’s company.

location
string

User’s location.

custom_attributes
object

Custom attribute(s) that have been assigned to the user.

login_type
integer

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)

The following login methods are only available in China:

11 — Phone number
21 — WeChat
23 — Alipay

1 validation
role_id
string

Unique identifier of the role assigned to the user.

plan_united_type
string

United plan type. Only returned if user is enrolled in the Zoom United plan.

employee_unique_id
string

The employee’s unique ID. This field only returns when:

  • SAML single sign-on (SSO) is enabled.
  • The login_type value is 101 (SSO).
account_number
integer

The user’s account number.

1 validation
manager
string

The manager for the user.

1 validation
pronouns
string

The user’s pronouns.

pronouns_option
integer

The user’s display pronouns setting:

  • 1 — Ask the user every time they join meetings and webinars.
  • 2 — Always display pronouns in meetings and webinars.
  • 3 — Do not display pronouns in meetings and webinars.
1 validation

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