The Zoom User API lets developers access data related to Contact Groups, Groups, and Users. Use this API to build private services or public applications on the Zoom App Marketplace. Learn how to get your credentials and create private/public applications in our Authorization Guide.
openapi: 3.0.1
info:
title: 'Zoom user/'
description: Needs description.
contact:
name: Zoom Developers
url: https://zoom.us/developer
email: [email protected]
license:
name: MIT
url: https://opensource.org/licenses/MIT
version: 1.0.0
externalDocs:
description: Zoom REST API Documentation
url: https://zoom.github.io/api
servers:
- url: https://api.zoom.us/v1
security:
- api_key: []
- api_secret: []
tags:
- name: User
paths:
/user/assistant/delete:
post:
tags:
- User
description: |+
Delete a user's assistant.
operationId: userAssistantDelete
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: string
description: The host’s user id.
host_email:
type: string
description: The host’s email address.
responses:
'200':
description: Success
content:
application/json:
example:
id: unique_id
host_email: email_address
updated_at: '2013-09-02T12:00:00.000Z'
/user/assistant/set:
post:
tags:
- User
description: |+
Set a user's assistant which can schedule meeting for him.
operationId: userAssistantSet
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- assistant_email
type: object
properties:
id:
type: string
description: The host’s user id.
host_email:
type: string
description: 'The host’s email address. '
assistant_email:
type: string
description: The assistant’s email address.
required: true
responses:
'200':
description: Success
content:
application/json:
example:
id: unique_id
host_email: email_address
updated_at: '2013-09-02T12:00:00.000Z'
/user/autocreate:
post:
tags:
- User
description: >+
Create a user on Zoom, returns the created user ID.
<aside class="notice">
The API is provided for enterprise customer who has a managed domain
</aside>
<aside class="warning">
This feature is disabled by default because of the security risk
involved in creating a user who does not belong to your domain without
notifying the user. You need to contact Zoom customer support if you
want to use this API
</aside>
operationId: userAutocreate
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- email
- password
- type
type: object
properties:
email:
type: string
description: >-
A valid email address. It must be unique in Zoom service. If
an email address is existed, a "user existing" error message
will be return
type:
type: string
description: >-
User’s type. 1 for basic user, 2 for pro user, 3 for corp
user. Basic user can host up to 40 minutes meeting
password:
type: string
description: User's password
first_name:
type: string
description: User's first name
last_name:
type: string
description: User's last name
disable_chat:
type: boolean
description: Disable in-meeting chat
default: false
enable_e2e_encryption:
type: boolean
description: Enable end-to-end encryption
default: false
enable_silent_mode:
type: boolean
description: Enable attendee on-hold
default: false
disable_group_hd:
type: boolean
description: Disable Group HD
default: false
disable_recording:
type: boolean
description: Disable recording
default: false
enable_cmr:
type: boolean
description: Enable cloud meeting record
default: false
enable_auto_recording:
type: boolean
description: >-
Enable automatic recording. By default, if
"enable_cloud_auto_recording" is true, it will become true
default: false
enable_cloud_auto_recording:
type: boolean
description: Enable cloud automatic recording
default: false
track_id:
type: string
description: Referral partner track ID
meeting_capacity:
type: string
description: >-
User’s meeting capacity, 0 means following account’s meeting
capacity
default: '0'
enable_webinar:
type: string
description: Enable webinar feature
webinar_capacity:
type: string
description: >-
Enable webinar capacity, can be 100, 500, 1000, 3000, 5000
or 10000, depends on if having related webinar capacity plan
subscription or not
default: '0'
enable_large:
type: string
description: Enable large meting feature
large_capacity:
type: string
description: >-
Enable large meeting capacity, can be 100, 200, 300 or 500,
depends on if having related webinar capacity plan
subscription or not
default: '0'
disable_feedback:
type: boolean
description: Disable feedback
default: false
disable_jbh_reminder:
type: boolean
description: Disable jbh email reminder
default: false
enable_breakout_room:
type: boolean
description: Enable breakout room
default: false
enable_polling:
type: boolean
description: Enable polling for meeting
default: false
enable_annotation:
type: boolean
description: Enable Annotation
default: true
enable_share_dual_camera:
type: boolean
description: Enable Share dual camera
default: false
enable_far_end_camera_control:
type: boolean
description: Enable Far end camera control
default: false
disable_private_chat:
type: boolean
description: Disable Private chat
default: false
enable_enter_exit_chime:
type: boolean
description: Enable Enter/exit chime
default: false
option_enter_exit_chime_type:
type: string
description: >-
Enter/exit chime type. 0 means Heard by all including host
and attendees, 1 means Heard by host only
default: '0'
disable_cancel_meeting_notification:
type: boolean
description: Disable email notification when a meeting is cancelled
default: false
enable_remote_support:
type: boolean
description: Enable Remote support
default: false
enable_file_transfer:
type: boolean
description: Enable File transfer
default: false
enable_virtual_background:
type: boolean
description: Enable Virtual background
default: false
enable_attention_tracking:
type: boolean
description: Enable Attention tracking
default: false
enable_waiting_room:
type: boolean
description: Enable Waiting room
default: false
enable_closed_caption:
type: boolean
description: Enable Closed caption
default: false
enable_co_host:
type: boolean
description: Enable Co-host
default: false
enable_auto_saving_chats:
type: boolean
description: Enable Auto saving chats
default: false
enable_phone_participants_password:
type: boolean
description: >-
Enable Generate and require password for participants
joining by phone
default: false
enable_auto_delete_cmr:
type: boolean
description: Enable Auto delete cloud recordings
default: false
auto_delete_cmr_days:
type: string
description: Auto delete cloud recordings after days
dept:
type: string
description: Department for user profile, use for repor
group_id:
type: string
description: >-
User Group ID. If set default user group, the parameter’s
default value is the default user group
imgroup_id:
type: string
description: >-
IM Group ID. If set default im group, the parameter’s
default value is the default im group
required: true
responses:
'200':
description: Success
content:
application/json:
example:
email: email_address
id: unique_id
created_at: '2012-11-25T12:00:00.000Z'
first_name: Zoomie
last_name: Userton
pic_url: ''
type: 1
disable_chat: false
enable_e2e_encryption: false
enable_silent_mode: true
disable_group_hd: false
disable_recording: false
enable_cmr: false
enable_auto_recording: false
enable_cloud_auto_recording: false
verified: 1
pmi: 2035134243
meeting_capacity: 0
enable_webinar: false
webinar_capacity: 0
enable_large: false
large_capacity: 0
disable_feedback: false
disable_jbh_reminder: true
enable_breakout_room: true
enable_polling: false
enable_annotation: false
enable_share_dual_camera: false
enable_far_end_camera_control: false
disable_private_chat: false
enable_enter_exit_chime: false
disable_cancel_meeting_notification: false
enable_remote_support: false
enable_file_transfer: false
enable_virtual_background: false
enable_attention_tracking: false
enable_waiting_room: false
enable_closed_caption: false
enable_co_host: false
enable_auto_saving_chats: false
enable_phone_participants_password: false
enable_auto_delete_cmr: true
auto_delete_cmr_days: 30
dept: Engineer
lastClientVersion: ''
lastLoginTime: ''
token: ''
zpk: ''
zak: ''
/user/checkemail:
post:
tags:
- User
description: |+
Check if the user email exists.
operationId: userCheckemail
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- email
type: object
properties:
email:
type: string
description: User email.
required: true
responses:
'200':
description: Success
content:
application/json:
example:
existed_email: true
/user/checkzpk:
post:
tags:
- User
description: |+
Check if the zpk is expired. The zpk is used to authenticate a user.
operationId: userCheckzpk
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- zpk
type: object
properties:
zpk:
type: string
description: User zpk.
required: true
responses:
'200':
description: Success
content:
application/json:
example:
expire_in: 7187
/user/create:
post:
tags:
- User
description: >+
Create a user on Zoom, returns the created user ID.
<aside class="notice">
Your account must have this privilege to provisioning user. Zoom only
assigns this privilege to a trusted partner
</aside>
<aside class="notice">
User will get an email sent from Zoom. There is a confirmation link in
this email. User will then need to click this link to activate their
account to the Zoom service. The user can set or change their password
in Zoom.
</aside>
operationId: userCreate
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- email
- type
type: object
properties:
email:
type: string
description: >-
A valid email address. It must be unique in Zoom service. If
an email address is existed, a "user existing" error message
will be return
type:
type: string
description: >-
User’s type. 1 for basic user, 2 for pro user, 3 for corp
user. Basic user can host up to 40 minutes meeting
first_name:
type: string
description: User's first name
last_name:
type: string
description: User's last name
disable_chat:
type: boolean
description: Disable in-meeting chat
default: false
enable_e2e_encryption:
type: boolean
description: Enable end-to-end encryption
default: false
enable_silent_mode:
type: boolean
description: Enable attendee on-hold
default: false
disable_group_hd:
type: boolean
description: Disable Group HD
default: false
disable_recording:
type: boolean
description: Disable recording
default: false
enable_cmr:
type: boolean
description: Enable cloud meeting record
default: false
enable_auto_recording:
type: boolean
description: >-
Enable automatic recording. By default, if
"enable_cloud_auto_recording" is true, it will become true
default: false
enable_cloud_auto_recording:
type: boolean
description: Enable cloud automatic recording
default: false
track_id:
type: string
description: Referral partner track ID
meeting_capacity:
type: string
description: >-
User’s meeting capacity, passing 0 will inherit account’s
meeting capacity
default: '0'
enable_webinar:
type: string
description: Enable webinar feature
webinar_capacity:
type: string
description: >-
Enable webinar capacity, can be 100, 500, 1000, 3000, 5000
or 10000, depends on if having related webinar capacity plan
subscription or not
default: '0'
enable_large:
type: string
description: Enable large meting feature
large_capacity:
type: string
description: >-
Enable large meeting capacity, can be 100, 200, 300 or 500,
depends on if having related webinar capacity plan
subscription or not
default: '0'
disable_feedback:
type: boolean
description: Disable feedback
default: false
disable_jbh_reminder:
type: boolean
description: Disable jbh email reminder
default: false
enable_breakout_room:
type: boolean
description: Enable breakout room
default: false
enable_polling:
type: boolean
description: Enable polling for meeting
default: false
enable_annotation:
type: boolean
description: Enable Annotation
default: true
enable_share_dual_camera:
type: boolean
description: Enable Share dual camera
default: false
enable_far_end_camera_control:
type: boolean
description: Enable Far end camera control
default: false
disable_private_chat:
type: boolean
description: Disable Private chat
default: false
enable_enter_exit_chime:
type: boolean
description: Enable Enter/exit chime
default: false
option_enter_exit_chime_type:
type: string
description: >-
Enter/exit chime type. 0 means Heard by all including host
and attendees, 1 means Heard by host only
default: '0'
disable_cancel_meeting_notification:
type: boolean
description: Disable email notification when a meeting is cancelled
default: false
enable_remote_support:
type: boolean
description: Enable Remote support
default: false
enable_file_transfer:
type: boolean
description: Enable File transfer
default: false
enable_virtual_background:
type: boolean
description: Enable Virtual background
default: false
enable_attention_tracking:
type: boolean
description: Enable Attention tracking
default: false
enable_waiting_room:
type: boolean
description: Enable Waiting room
default: false
enable_closed_caption:
type: boolean
description: Enable Closed caption
default: false
enable_co_host:
type: boolean
description: Enable Co-host
default: false
enable_auto_saving_chats:
type: boolean
description: Enable Auto saving chats
default: false
enable_phone_participants_password:
type: boolean
description: >-
Enable Generate and require password for participants
joining by phone
default: false
enable_auto_delete_cmr:
type: boolean
description: Enable Auto delete cloud recordings
default: false
auto_delete_cmr_days:
type: string
description: Auto delete cloud recordings after days
dept:
type: string
description: Department for user profile, use for repor
group_id:
type: string
description: >-
User Group ID. If set default user group, the parameter’s
default value is the default user group
imgroup_id:
type: string
description: >-
IM Group ID. If set default im group, the parameter’s
default value is the default im group
required: true
responses:
'200':
description: Success
content:
application/json:
example:
email: email_address
id: unique_id
created_at: '2012-11-25T12:00:00.000Z'
first_name: Zoom
last_name: User
pic_url: ''
type: 1
disable_chat: false
enable_e2e_encryption: false
enable_silent_mode: true
disable_group_hd: false
disable_recording: false
enable_cmr: false
enable_auto_recording: false
enable_cloud_auto_recording: false
verified: 1
pmi: 2035134243
meeting_capacity: 0
enable_webinar: false
webinar_capacity: 0
enable_large: false
large_capacity: 0
disable_feedback: false
disable_jbh_reminder: true
enable_breakout_room: true
enable_polling: false
enable_annotation: false
enable_share_dual_camera: false
enable_far_end_camera_control: false
disable_private_chat: false
enable_enter_exit_chime: false
disable_cancel_meeting_notification: false
enable_remote_support: false
enable_file_transfer: false
enable_virtual_background: false
enable_attention_tracking: false
enable_waiting_room: false
enable_closed_caption: false
enable_co_host: false
enable_auto_saving_chats: false
enable_phone_participants_password: false
enable_auto_delete_cmr: true
auto_delete_cmr_days: 30
dept: Engineer
lastClientVersion: ''
lastLoginTime: ''
token: ''
zpk: ''
zak: ''
/user/custcreate:
post:
tags:
- User
description: >+
Create a user on Zoom, returns the created user ID.
<aside class="notice">
The API is provided for API plan only
</aside>
<aside class="notice">
User created in this way has no password and is not able to log into the
Zoom web site or client
</aside>
operationId: userCustcreate
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- email
- type
type: object
properties:
email:
type: string
description: >-
A valid email address. It must be unique in Zoom service. If
an email address is existed, a "user existing" error message
will be return
type:
type: string
description: >-
User’s type. 1 for basic user, 2 for pro user, 3 for corp
user. Basic user can host up to 40 minutes meeting
first_name:
type: string
description: User's first name
last_name:
type: string
description: User's last name
disable_chat:
type: boolean
description: Disable in-meeting chat
default: false
enable_e2e_encryption:
type: boolean
description: Enable end-to-end encryption
default: false
enable_silent_mode:
type: boolean
description: Enable attendee on-hold
default: false
disable_group_hd:
type: boolean
description: Disable Group HD
default: false
disable_recording:
type: boolean
description: Disable recording
default: false
enable_cmr:
type: boolean
description: Enable cloud meeting record
default: false
enable_auto_recording:
type: boolean
description: >-
Enable automatic recording. By default, if
"enable_cloud_auto_recording" is true, it will become true
default: false
enable_cloud_auto_recording:
type: boolean
description: Enable cloud automatic recording
default: false
track_id:
type: string
description: Referral partner track ID
meeting_capacity:
type: string
description: >-
User’s meeting capacity, 0 means following account’s meeting
capacity
default: '0'
enable_webinar:
type: string
description: Enable webinar feature
webinar_capacity:
type: string
description: >-
Enable webinar capacity, can be 100, 500, 1000, 3000, 5000
or 10000, depends on if having related webinar capacity plan
subscription or not
default: '0'
enable_large:
type: string
description: Enable large meting feature
large_capacity:
type: string
description: >-
Enable large meeting capacity, can be 100, 200, 300 or 500,
depends on if having related webinar capacity plan
subscription or not
default: '0'
disable_feedback:
type: boolean
description: Disable feedback
default: false
disable_jbh_reminder:
type: boolean
description: Disable jbh email reminder
default: false
enable_breakout_room:
type: boolean
description: Enable breakout room
default: false
enable_polling:
type: boolean
description: Enable polling for meeting
default: false
enable_annotation:
type: boolean
description: Enable Annotation
default: true
enable_share_dual_camera:
type: boolean
description: Enable Share dual camera
default: false
enable_far_end_camera_control:
type: boolean
description: Enable Far end camera control
default: false
disable_private_chat:
type: boolean
description: Disable Private chat
default: false
enable_enter_exit_chime:
type: boolean
description: Enable Enter/exit chime
default: false
option_enter_exit_chime_type:
type: string
description: >-
Enter/exit chime type. 0 means Heard by all including host
and attendees, 1 means Heard by host only
default: '0'
disable_cancel_meeting_notification:
type: boolean
description: Disable email notification when a meeting is cancelled
default: false
enable_remote_support:
type: boolean
description: Enable Remote support
default: false
enable_file_transfer:
type: boolean
description: Enable File transfer
default: false
enable_virtual_background:
type: boolean
description: Enable Virtual background
default: false
enable_attention_tracking:
type: boolean
description: Enable Attention tracking
default: false
enable_waiting_room:
type: boolean
description: Enable Waiting room
default: false
enable_closed_caption:
type: boolean
description: Enable Closed caption
default: false
enable_co_host:
type: boolean
description: Enable Co-host
default: false
enable_auto_saving_chats:
type: boolean
description: Enable Auto saving chats
default: false
enable_phone_participants_password:
type: boolean
description: >-
Enable Generate and require password for participants
joining by phone
default: false
enable_auto_delete_cmr:
type: boolean
description: Enable Auto delete cloud recordings
default: false
auto_delete_cmr_days:
type: string
description: Auto delete
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoom/refs/heads/main/openapi/zoom-user--openapi-original.yml