Zoom API
  1. Users
Zoom API
  • Accounts
    • List sub accounts
      GET
    • Create a sub account
      POST
    • Disassociate a sub account
      DELETE
    • Get sub account details
      GET
    • Get locked settings
      GET
    • Update locked settings
      PATCH
    • Get managed domains
      GET
    • Update options
      PATCH
    • Update the account owner
      PUT
    • Get settings
      GET
    • Update settings
      PATCH
    • Delete virtual background files
      DELETE
    • Upload virtual background files
      POST
    • Get trusted domains
      GET
  • Billing
    • Get billing information
    • Update billing information
    • List billing invoices
    • Get invoice details
    • Get plan Information
    • Subscribe plans
    • Subscribe additional plan
    • Update an additional plan
    • Cancel additional plans
    • Update a base plan
    • Cancel a base plan
    • Get plan usage
    • Download an invoice file
  • Phone
    • Update BYOC settings
    • Set up a Zoom Phone account
    • Assign SIP trunks
    • Update SIP trunk details
    • Add BYOC phone numbers
    • Get account's call logs
    • List calling plans
    • Change main company number
    • List phone numbers
    • Get phone number details
    • Update phone number details
    • Get call recordings
    • List setting templates
    • Add a setting template
    • Get setting template details
    • Update a setting template
    • List BYOC SIP trunks
    • List phone users
    • Get user's profile
    • Update user's profile
    • Get user's call logs
    • Delete a user's call log
    • Assign calling plan to a user
    • Unassign user's calling plan
    • Assign phone number to user
    • Unassign phone number
    • Get user's recordings
    • Get user's settings
    • Remove shared access
    • Update shared access
    • Set up shared access
    • Get user's voicemails
    • Delete a voicemail
  • Cloud Recording
    • List recordings of an account
    • List archived files
    • Delete meeting recordings
    • Get meeting recordings
    • List recording registrants
    • Create a recording registrant
    • Get registration questions
    • Update registration questions
    • Update registrant's status
    • Get meeting recording settings
    • Update meeting recording settings
    • Recover meeting recordings
    • Delete a meeting recording file
    • Recover a single recording
    • List all recordings
  • SIP Connected Audio
    • List internal call-out countries
    • Add internal call-out countries
    • Delete internal call-out country
    • List internal numbers
    • Add internal numbers
    • Delete an internal number
    • Delete all numbers
    • Assign numbers
    • Assign SIP trunk configuration
    • List SIP trunks
    • Assign SIP trunks
    • Delete a SIP trunk
    • List SIP trunk numbers
  • Users
    • Switch a user's account
      PUT
    • List users
      GET
    • Create users
      POST
    • Check a user email
      GET
    • Get user's ZAK
      GET
    • Check a user's PM room
      GET
    • Delete a user
      DELETE
    • Get a user
      GET
    • Update a user
      PATCH
    • Delete user assistants
      DELETE
    • List user assistants
      GET
    • Add assistants
      POST
    • Delete a user assistant
      DELETE
    • Update a user's email
      PUT
    • Update a user's password
      PUT
    • Get user permissions
      GET
    • Upload a user's profile picture
      POST
    • Update a user's presence status
      PUT
    • Delete user schedulers
      DELETE
    • List user schedulers
      GET
    • Delete a scheduler
      DELETE
    • Get user settings
      GET
    • Update user settings
      PATCH
    • Delete virtual background files
      DELETE
    • Upload virtual background files
      POST
    • Update user status
      PUT
    • Revoke a user's SSO token
      DELETE
    • Get a user token
      GET
  • Chat Channels
    • Delete a channel
    • Get a channel
    • Update a channel
    • Leave a channel
    • Join a channel
    • Remove a member
    • List user's channels
    • Create a channel
  • Contacts
    • List user's contacts
    • Get user's contact details
    • Search company contacts
  • Chat Channels (Account-level)
    • Delete a channel
    • Get a channel
    • Update a channel
    • List channel members
    • Invite channel members
    • Remove a member
  • Chat Messages
    • List user's chat messages
    • Send a chat message
    • Delete a message
    • Update a message
  • Groups
    • List groups
    • Create a group
    • Delete a group
    • Get a group
    • Update a group
    • Get locked settings
    • Update locked settings
    • List group members
    • Add group members
    • Delete a group member
    • Update a group member
    • Get a group's settings
    • Update a group's settings
    • Delete virtual background files
    • Upload virtual background files
  • Devices
    • List H.323/SIP devices
    • Create a H.323/SIP device
    • Delete a H.323/SIP device
    • Update a H.323/SIP device
  • Chatbot Messages
    • Send chatbot messages
    • Delete a chatbot message
    • Edit a chatbot message
  • IM Chat
    • Get IM chat sessions
    • Get IM chat messages
    • Send IM messages
    • Get user’s IM messages
  • IM Groups
    • List IM directory groups
    • Create an IM directory group
    • Delete an IM directory group
    • Retrieve an IM directory group
    • Update an IM directory group
    • List IM directory group members
    • Add IM directory group members
    • Delete an IM directory group member
  • Meetings
    • Use in-Meeting recording controls
    • Delete a meeting
    • Get a meeting
    • Update a meeting
    • Perform batch poll creation
    • Get meeting invitation
    • Get live stream details
    • Update a live stream
    • Update Live Stream Status
    • List meeting polls
    • Create a meeting poll
    • Delete a meeting poll
    • Get a meeting poll
    • Update a meeting poll
    • List meeting registrants
    • Add meeting registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a meeting registrant
    • Update meeting status
    • List ended meeting instances
    • List past meeting's poll results
    • Get past meeting details
    • Get past meeting participants
    • List meeting templates
    • List meetings
    • Create a meeting
  • Dashboards
    • List Zoom meetings client feedback
    • Get zoom meetings client feedback
    • List client meeting satisfaction
    • Get CRC port usage
    • Get IM metrics
    • Get top 25 Zoom Rooms with issues
    • Get issues of Zoom Rooms
    • List meetings
    • Get meeting details
    • List meeting participants
    • List meeting participants QoS
    • Get post meeting feedback
    • Get sharing/recording details
    • Get meeting participant QoS
    • List webinars
    • Get webinar details
    • Get webinar participants
    • List webinar participant QoS
    • Get post webinar feedback
    • Get sharing/recording details
    • Get webinar participant QoS
    • List Zoom Rooms
    • Get top 25 issues of Zoom Rooms
    • Get Zoom Rooms details
    • List call logs
    • Get call QoS
    • Get call details from call log
  • Deprecated API Endpoints
    • List past meeting's files
    • List past webinar files
  • Webinars
    • Get webinar absentees
    • List past webinar instances
    • List webinar participants
    • List past webinar poll results
    • List Q&A of past webinar
    • List webinar templates
    • List webinars
    • Create a webinar
    • Delete a webinar
    • Get a webinar
    • Update a webinar
    • Perform batch registration
    • Remove panelists
    • List panelists
    • Add panelists
    • Remove a panelist
    • List a webinar's polls
    • Create a webinar's poll
    • Delete a webinar poll
    • Get a webinar poll
    • Update a webinar poll
    • List webinar registrants
    • Add a webinar registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a webinar registrant
    • Get a webinar registrant
    • Update webinar status
    • Get webinar tracking sources
  • Phone Auto Receptionists
    • Add an auto receptionist
    • Update auto receptionist details
    • Unassign all phone numbers
    • Assign phone numbers
    • Unassign a phone number
  • Phone Blocked List
    • List blocked lists
    • Create a blocked list
    • Delete a blocked list
    • Get blocked list details
    • Update a blocked list
  • Phone Call Queues
    • List call queues
    • Create a call queue
    • Delete a call queue
    • Get call queue details
    • Update call queue details
    • Change call queue manager
    • Unassign all members
    • Add members to a call queue
    • Unassign a member
    • Unassign all phone numbers
    • Assign numbers to a call queue
    • Unassign a phone number
    • Get call queue recordings
  • Common Area Phones
    • List common area phones
    • Add a common area phone
    • Delete a common area phone
    • Get common area phone details
    • Update common area phone
  • Phone Devices
    • List devices
    • Add a device
    • Delete a device
    • Get device details
    • Update a device
  • Phone Reports
    • Get operation logs report
  • Phone Shared Line Groups
    • List shared line groups
    • Create a shared line group
    • Delete a shared line group
    • Get a shared line group
    • Update a shared line group
    • Unassign members of a shared line group
    • Add members to a shared line group
    • Unassign a member from a shared line group
    • Assign phone numbers
    • Unassign a phone number
  • Phone Site
    • List phone sites
    • Create a phone site
    • Delete a phone site
    • Get phone site details
    • Update phone site details
  • Reports
    • Get sign In / sign out activity report
    • Get cloud recording usage report
    • Get daily usage report
    • Get meeting detail reports
    • Get meeting participant reports
    • Get meeting poll reports
    • Get operation logs report
    • Get telephone reports
    • Get active/inactive host reports
    • Get meeting reports
    • Get webinar detail reports
    • Get webinar participant reports
    • Get webinar poll reports
    • Get webinar Q&A report
  • Roles
    • List roles
    • Create a role
    • Delete a role
    • Get role information
    • Update role information
    • List members in a role
    • Assign a role
    • Unassign a role
  • Rooms
    • List Zoom Rooms
    • Add a Zoom Room
    • List digital signage contents
    • Update E911 digital signage
    • Check-in or check-out of a Zoom Room
    • Delete a Zoom Room
    • Get Zoom Room profile
    • Update a Zoom Room profile
    • List Zoom Room devices
    • Change a Zoom Room's location
    • Get Zoom Room settings
    • Update Zoom Room settings
  • Rooms Account
    • Get Zoom Room account profile
    • Update Zoom Room account profile
    • Get Zoom Room account settings
    • Update Zoom Room account settings
  • Rooms Location
    • List Zoom Room locations
    • Add a location
    • Get Zoom Room location structure
    • Update Zoom Rooms location structure
    • Get Zoom Room location profile
    • Update Zoom Room location profile
    • Change the assigned parent location
    • Get location settings
    • Update location settings
  • Rooms Devices
    • Change Zoom Rooms' app version
  • SIP Phone
    • List SIP phones
    • Enable SIP phone
    • Delete SIP phone
    • Update SIP phone
  • TrackingField
    • List tracking fields
    • Create a tracking field
    • Delete a tracking field
    • Get a tracking field
    • Update a tracking field
  • TSP
    • Get account's TSP information
    • Update account's TSP information
    • List user's TSP accounts
    • Add a user's TSP account
    • Set global dial-in URL for a TSP user
    • Delete a user's TSP account
    • Get a user's TSP account
    • Update a TSP account
  • PAC
    • List a user's PAC accounts
  • Data Compliance
  • Webhooks
  • master account APIs
  1. Users

Get a user

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
Rate Limit Label: Light
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.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://api.zoom.us/v2/users/'
响应示例响应示例
200 - response
{
    "account_id": "EAAAAAbbbbbCCCCHMA",
    "created_at": "2018-11-15T01:10:08Z",
    "custom_attributes": [
        {
            "key": "cb3674544gexq",
            "name": "Country of Citizenship",
            "value": "Nepal"
        }
    ],
    "dept": "",
    "email": "harryg@dfkjdslfjkdsfjkdsf.fsdfdfd",
    "first_name": "Harry",
    "group_ids": [],
    "host_key": "0000",
    "id": "z8dsdsdsdsdCfp8uQ",
    "im_group_ids": [
        "CcSAAAAAAABBBVoQ"
    ],
    "jid": "hghghfghdfghdfhgh@xmpp.zoom.us",
    "language": "en-US",
    "last_client_version": "4.4.55383.0716(android)",
    "last_login_time": "2019-09-13T21:08:52Z",
    "last_name": "Grande",
    "manager": "name@example.com",
    "personal_meeting_url": "https://zoom.us/j/6352635623323434343443",
    "phone_country": "USA",
    "phone_number": "00000000",
    "pic_url": "https://lh4.googleusercontent.com/-hsgfhdgsfghdsfghfd-photo.jpg",
    "pmi": 100000000,
    "role_id": "hdsfwyteg3675hgfs",
    "role_name": "Owner",
    "status": "active",
    "timezone": "America/Los_Angeles",
    "type": 2,
    "use_pmi": false,
    "verified": 1
}

请求参数

Path 参数
userId
string 
必需
The user ID or email address of the user. For user-level apps, pass me as the value for userId.
Query 参数
login_type
enum<string> 
可选
0 - Facebook.
1 - Google.
99 - API.
100 - Zoom.
101 - SSO.
枚举值:
0199100101

返回响应

🟢200**HTTP Status Code:** `200` **OK**<br> User object returned.
application/json
Body
The user object represents a specific user on Zoom.
id
string 
User ID.
可选
created_at
string <date-time>
可选
The date and time at which this user was created.
dept
string 
可选
Department.
email
string 
必需
User's email address.
默认值:
john.doe@email.com
first_name
string 
可选
User's first name.
<= 64 字符
last_client_version
string 
可选
User last login client version.
last_login_time
string <date-time>
可选
User last login time.
last_name
string 
可选
User's last name.
<= 64 字符
pmi
integer <int64>
可选
Personal meeting ID.
role_name
string 
可选
User's role name.
timezone
string 
可选
The time zone of the user.
type
enum<integer> 
必需
User's plan type:
1 - Basic.
2 - Licensed.
3 - On-prem.
99 - None (this can only be set with ssoCreate).
枚举值:
12399
use_pmi
boolean 
可选
Displays true if user has enabled PMI for instant meetinsgs, false otherwise.
默认值:
false
account_id
string 
可选
User's account ID.
cms_user_id
string 
可选
CMS ID of user, only enabled for Kaltura integration.
company
string 
可选
User's company.
custom_attributes
object 
可选
Custom attribute(s) that have been assigned to the user.
key
string 
可选
Identifier for the custom attribute.
name
string 
可选
Name of the custom attribute.
value
string 
可选
Value of the custom attribute.
group_ids
array[string]
可选
IDs of the web groups user belongs to.
host_key
string 
可选
User's host key.
im_group_ids
array[string]
可选
IM IDs of the groups user belongs to.
jid
string 
可选
job_title
string 
可选
User's job title.
language
string 
可选
Default language for the Zoom Web Portal.
location
string 
可选
User's location.
login_type
enum<integer> 
可选
Login type.
0 : Facebook
1 : Google
99 : API
100 : ZOOM
101 : SSO
枚举值:
0199100101
manager
string <email>
可选
The manager for the user.
personal_meeting_url
string 
可选
User's personal meeting url.
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
object 
可选
code
string 
可选
Country code of the phone number. For example, for United States phone numbers, the value of this field should be "+1".
country
string 
可选
Country ID of the phone number. For example, if the phone number provided in the number field is a Brazil based number, the value of the country field should be BR.
number
string 
可选
Phone number of the user.
verified
boolean 
可选
Indicates whether the phone number has been verified by Zoom or not.
pic_url
string 
可选
The URL for user's profile picture.
plan_united_type
string 
可选
United plan type. Only returned if user is enrolled in the Zoom United plan.
role_id
string 
可选
Unique identifier of the role assigned to the user.
status
enum<string> 
可选
Status of user's account.
枚举值:
pendingactiveinactive
vanity_url
string 
可选
Personal meeting room URL, if the user has one.
verified
integer 
可选
Displays whether user is verified or not.
1 - Account verified.
0 - Account not verified.
🟠400**HTTP Status Code:** `400` **Bad Request**<br> Bad request<br> **Error Code:** `1120`<br> A valid invitation to join the Zoom account was not found for this user. <br> This error is thrown if you added a user in your account but the user did not accept t
🟠404**HTTP Status Code:** `404` **Not Found**<br> **Error Code:** `1001`<br> User does not exist: $userId.<br>

【Zoom】API开发者 微信交流群

用微信扫右侧二维码，加入【Zoom】API开发者 交流群，互助沟通

扫码加入交流群
修改于 2024-04-24 09:06:48
上一页
Delete a user
下一页
Update a user
Built with