REST User API Follow

Update: Please see our Developer Portal for more up to date content on our REST API and Mobile SDK.

The following API calls go over the creation, management, and deleting of Users through Zooms REST API calls.

Create a user on Zoom, returns the create user id.

Note:

  1. Your account must have this privilege to provisioning user. Zoom only assigns this privilege to a trusted partner.
  2. 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.

Endpoint

https://api.zoom.us/v1/user/create

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&email=user@email.com&type=1' https://api.zoom.us/v1/user/create

 

Response XML: 

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<email>test@abc.com</email>
	<id>dsfs23css23</id>
	<created_at>2012-11-25T12:00:00Z</created_at>
	<first_name>Lucy </first_name>
	<last_name>Li</last_name>
	<pic_url></pic_url>
	<type>1</type>
	<disable_chat>false</disable_chat>
	<enable_e2e_encryption>false</enable_e2e_encryption>
	<enable_silent_mode>false</enable_silent_mode>
	<disable_group_hd>false</disable_group_hd>
	<disable_recording>false</disable_recording>
	<enable_cmr>false</ enable_cmr>
	<enable_auto_recording>false</ enable_auto_recording>
	<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
	<verified>1</verified>
	<pmi>2035134243</pmi>
	<meeting_capacity>0</meeting_capacity>
	<enable_webinar>false</enable_webinar>
	<webinar_capacity>0</webinar_capacity>
	<enable_large>false</enable_large>
	<large_capacity>0</large_capacity>
	<disable_feedback>false</disable_feedback>
	<disable_jbh_reminder>false</disable_jbh_reminder>
	<enable_breakout_room>true</enable_breakout_room>
	<dept>Engineer</dept >
	<lastClientVersion></lastClientVersion>
	<lastLoginTime></lastLoginTime>
	<token></token>
	<zpk></zpk>
</result >

Response JSON:

{
	"email": "test@abc.com ",
	"id": "dsfs23css23",
	"created_at": "2012-11-25T12:00:00Z",
	"first_name": "Lucy",
	"last_name": "Li",
	"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,
	"dept":"Engineer",
	"lastClientVersion": "",
	"lastLoginTime": "",
	"token":"",
	"zpk":""
}

Note: This API will not respond with actual values for the following fields due to user privacy policies:

Create a user on Zoom, return the created user id.

Note:

  1. The API is provided for enterprise customer who has a managed domain.
  2. User created in this way will not receive the confirmation email, and email addresses must satisfy "managed domain".

Endpoint

https://api.zoom.us/v1/user/autocreate

Parameters:

cURL Example:
curl --data 'api_key=your_api_key&api_secret=your_api_secret&email=user@manageddomain.com&type=1' https://api.zoom.us/v1/user/autocreate
 

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<email>test@abc.com</email>
	<id>dsfs23css23</id>
	<created_at>2012-11-25T12:00:00Z</created_at>
	<pic_url></pic_url>
	<type>1</type>
	<first_name>Lucy </first_name>
	<last_name>Li</last_name>
	<disable_chat>false </disable_chat>
	<enable_e2e_encryption>false</enable_e2e_encryption>
	<enable_silent_mode>false</enable_silent_mode>
	<disable_group_hd>false</disable_group_hd>
	<disable_recording>false</disable_recording>
	<enable_cmr>false</ enable_cmr>
	<enable_auto_recording>false</ enable_auto_recording>
	<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
	<verified>1</verified>
	<pmi>2035134243</pmi>
	<meeting_capacity>0</meeting_capacity>
	<enable_webinar>true</enable_webinar>
	<webinar_capacity>100</webinar_capacity>
	<enable_large>false</enable_large>
	<large_capacity>0</large_capacity>
	<disable_feedback>false</disable_feedback>
	<disable_jbh_reminder>false</disable_jbh_reminder>
	<enable_breakout_room>true</enable_breakout_room>
	<dept>Engineer</dept >
	<lastClientVersion></lastClientVersion>
	<lastLoginTime></lastLoginTime>
	<token></token>
	<zpk></zpk>
</result >

Response JSON:

{
	"email": "test@abc.com ",
	"id": "dsfs23css23",
	"created_at": "2012-11-25T12:00:00Z",
	"first_name": "Lucy",
	"last_name": "Li",
	"disable_chat": false,
	"enable_e2e_encryption": false,
	"pic_url": "",
	"type": 1,
	"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,
	"meeting_capacity": 0,
	"enable_webinar":true,
	"webinar_capacity":100,
	"enable_large":false,
	"large_capacity": 0,
	"disable_feedback":false,
	"disable_jbh_reminder": true,
	"enable_breakout_room": true,
	"dept":"Engineer",
	"lastClientVersion": "",
	"lastLoginTime": "",
	"token":"",
	"zpk":""
}

Create a user on Zoom, return the created user id.

Note:

  1. The API is provided for API partner only.
  2. User created in this way has no password and is not able to log into the Zoom web site or client.

Endpoint

https://api.zoom.us/v1/user/custcreate

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&email=user@email.com&type=1' https://api.zoom.us/v1/user/custcreate

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<email>test@abc.com</email>
	<id>dsfs23css23</id>
	<created_at>2012-11-25T12:00:00Z</created_at>
	<pic_url></pic_url>
	<type>1</type>
	<first_name>Lucy </first_name>
	<last_name>Li</last_name>
	<disable_chat>false </disable_chat>
	<enable_e2e_encryption>false</enable_e2e_encryption>
	<enable_silent_mode>false</enable_silent_mode>
	<disable_group_hd>false</disable_group_hd>
	<disable_recording>false</disable_recording>
	<enable_cmr>false</ enable_cmr>
	<enable_auto_recording>false</ enable_auto_recording>
	<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
	<verified>1</verified>
	<pmi>2035134243</pmi>
	<meeting_capacity>0</meeting_capacity>
	<enable_webinar>true</enable_webinar>
	<webinar_capacity>100</webinar_capacity>
	<enable_large>false</enable_large>
	<large_capacity>0</large_capacity>
	<disable_feedback>false</disable_feedback>
	<disable_jbh_reminder>false</disable_jbh_reminder>
	<enable_breakout_room>true</enable_breakout_room>
	<dept>Engineer</dept >
	<lastClientVersion></lastClientVersion>
	<lastLoginTime></lastLoginTime>
	<token></token>
	<zpk></zpk>
</result >

Response JSON:

{
	"email": "test@abc.com ",
	"id": "dsfs23css23",
	"created_at": "2012-11-25T12:00:00Z",
	"first_name": "Lucy",
	"last_name": "Li",
	"type": 1,
	"disable_chat": false,
	"enable_e2e_encryption": false,
	"pic_url": "",
	"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":true,
	"webinar_capacity":100,
	"enable_large":false,
	"large_capacity": 0,
	"disable_feedback":false,
	"disable_jbh_reminder":false,
	"enable_breakout_room": true,
	"dept": "Engineer",
	"lastClientVersion": "",
	"lastLoginTime": "",
	"token":"",
	"zpk":""
}

Delete a user on Zoom, return the deleted user id.

Endpoint:

https://api.zoom.us/v1/user/delete

Parameters:

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>65q23kd9sqliy612h23k</id>
    <account_id>562q23kd9sqliy612h78k</account_id>
    <deleted_at>2012-11-25T12:00:00Z</deleted_at>
</result>

Response JSON:

{
    "id": "65q23kd9sqliy612h23k",
    "account_id":" 562q23kd9sqliy612h78k",
    "deleted_at": "2012-11-25T12:00:00Z"
}
cURL Example:
curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=user_id' https://api.zoom.us/v1/user/delete

List all the users on Zoom.

Endpoint: 

https://api.zoom.us/v1/user/list

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret' https://api.zoom.us/v1/user/list

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<page_count>5<page_count>
	<total_records>235<total_records>
	<page_number>1<page_number>
	<page_size>50<page_size>
	<users>
		<user>
			<email>test@abc.com</email>
			<id>dsfs23css23</id>
			<created_at>2012-11-25T12:00:00Z</created_at>
			<type>1</type>
			<first_name>Lucy </first_name>
			<last_name>Li</last_name>
			<pic_url>https://www.zoom.us/p/bNsPi</pic_url>
			<disable_chat>false </disable_chat>
			<enable_e2e_encryption>false</enable_e2e_encryption>
			<enable_silent_mode>false</enable_silent_mode>
			<disable_group_hd>false</disable_group_hd>
			<disable_recording>false</disable_recording>
			<enable_cmr>false</ enable_cmr>
			<enable_auto_recording>false</ enable_auto_recording>
			<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
			<verified>0</verified>
			<pmi>2035134243</pmi>
			<meeting_capacity>0</meeting_capacity>
			<enable_webinar>true</enable_webinar>
			<webinar_capacity>100</webinar_capacity>
			<enable_large>false</enable_large>
			<large_capacity>0</large_capacity>
			<disable_feedback>false</disable_feedback>
			<disable_jbh_reminder>false</disable_jbh_reminder>
			<enable_breakout_room>false</enable_breakout_room>
			<dept>Engineer</dept >
			<timezone>America/Los_Angeles</timezone>
			<lastClientVersion>3.5.44664.0321(mac)</lastClientVersion>
			<lastLoginTime>2016-03-23T09:54:41Z</lastLoginTime>
			<token></token>
			<zpk></zpk>
		</user>
		<user>
			<email>test2@abc.com</email>
			<id>dsfs23css23</id>
			<created_at>2012-11-25T12:00:00Z</created_at>
			<type>2</type>
			<first_name>Lily </first_name>
			<last_name>Sun</last_name>
			<pic_url>https://www.zoom.us/p/aPsPi</pic_url>
			<disable_chat>false </disable_chat>
			<enable_e2e_encryption>false</enable_e2e_encryption>
			<enable_silent_mode>false</enable_silent_mode>
			<disable_group_hd>false</disable_group_hd>
			<disable_recording>false</disable_recording>
			<enable_cmr>false</ enable_cmr>
			<enable_auto_recording>false</ enable_auto_recording>
			<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
			<verified>1</verified>
			<pmi>2035134241</pmi>
			<meeting_capacity>0</meeting_capacity>
			<enable_webinar>true</enable_webinar>
			<webinar_capacity>100</webinar_capacity>
			<enable_large>false</enable_large>
			<large_capacity>0</large_capacity>
			<disable_feedback>false</disable_feedback>
			<disable_jbh_reminder>false</disable_jbh_reminder>
			<enable_breakout_room>false</enable_breakout_room>
			<dept>Engineer</dept >
			<timezone>America/Los_Angeles</timezone>
			<lastClientVersion>3.5.44664.0321(mac)</lastClientVersion>
			<lastLoginTime>2016-03-23T09:54:41Z</lastLoginTime>
			<token></token>
			<zpk></zpk>
		</user>
	...
	</users>
</result>

Response JSON:

{
	"page_count": 5,
	"total_records": 235,
	"page_number": 1,
	"page_size": 50,
	"users": [
	{
		"email": "test@abc.com ",
		"id": "dsfs23css23",
		"created_at": "2012-11-25T12:00:00Z",
		"first_name": "Lucy",
		"last_name": "Li",
		"type": 1,
		"pic_url": "https://www.zoom.us/p/bNsPi", 
		"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": 0,
		"pmi": 2035134243,
		"meeting_capacity": 0,
		"enable_webinar":true,
		"webinar_capacity":100,
		"enable_large":false,
		"large_capacity": 0,
		"disable_feedback":false,
		"disable_jbh_reminder": true,
		"enable_breakout_room": false,
		"dept”:”Engineer”,
		"timezone": "America/Los_Angeles",
		"lastClientVersion": "3.5.44664.0321(mac)",
		"lastLoginTime": "2016-03-23T09:54:41Z",
		"token":"",
		"zpk":""
	},
	{
		"email": "test2@abc.com ",
		"id": "dsfs23css23",
		"created_at": "2012-11-25T12:00:00Z",
		"first_name": "Lily",
		"last_name": "Sun",
		"type": 2,
		"pic_url": "https://www.zoom.us/p/bNsPi", 
		"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": 2035134241,
		"meeting_capacity": 0,
		"enable_webinar":true,
		"webinar_capacity":100,
		"enable_large":false,
		"large_capacity": 0,
		"disable_feedback":false,
		"disable_jbh_reminder": true,
		"enable_breakout_room": false,
		"dept":"Engineer”,
		"timezone": "America/Los_Angeles",
		"lastClientVersion": "3.5.44664.0321(mac)",
		"lastLoginTime": "2016-03-23T09:54:41Z",
		"token":"",
		"zpk":""
	}
	...
	]
}

List all the pending users on Zoom.

Endpoint: 

https://api.zoom.us/v1/user/pending

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret' https://api.zoom.us/v1/user/pending

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<page_count>5<page_count>
	<total_records>235<total_records>
	<page_number>1<page_number>
	<page_size>50<page_size>
	<users>
		<user>
			<email>test@abc.com</email>
			<id>dsfs23css23</id>
			<created_at>2012-11-25T12:00:00Z</created_at>
			<type>1</type>
			<first_name>Lucy </first_name>
			<last_name>Li</last_name>
			<pic_url>https://www.zoom.us/p/bNsPi</pic_url>
			<disable_chat>false </disable_chat>
			<enable_e2e_encryption>false</enable_e2e_encryption>
			<enable_silent_mode>false</enable_silent_mode>
			<disable_group_hd>false</disable_group_hd>
			<disable_recording>false</disable_recording>
			<enable_cmr>false</ enable_cmr>
			<enable_auto_recording>false</ enable_auto_recording>
			<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
			<verified>0</verified>
			<pmi>0</pmi>
			<meeting_capacity>0</meeting_capacity>
			<enable_webinar>true</enable_webinar>
			<webinar_capacity>100</webinar_capacity>
			<enable_large>false</enable_large>
			<large_capacity>0</large_capacity>
			<disable_feedback>false</disable_feedback>
			<disable_jbh_reminder>false</disable_jbh_reminder>
			<enable_breakout_room>false</enable_breakout_room>
			<dept>Engineer</dept >
			<timezone>America/Los_Angeles</timezone>
			<lastClientVersion></lastClientVersion>
			<lastLoginTime></lastLoginTime>
			<token></token>
			<zpk></zpk>
		</user>
		<user>
			<email>test2@abc.com</email>
			<id>dsfs23css23</id>
			<created_at>2012-11-25T12:00:00Z</created_at>
			<type>2</type>
			<first_name>Lily </first_name>
			<last_name>Sun</last_name>
			<pic_url>https://www.zoom.us/p/aPsPi</pic_url>
			<disable_chat>false </disable_chat>
			<enable_e2e_encryption>false</enable_e2e_encryption>
			<enable_silent_mode>false</enable_silent_mode>
			<disable_group_hd>false</disable_group_hd>
			<disable_recording>false</disable_recording>
			<enable_cmr>false</ enable_cmr>
			<enable_auto_recording>false</ enable_auto_recording>
			<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
			<verified>0</verified>
			<pmi>0</pmi>
			<meeting_capacity>0</meeting_capacity>
			<enable_webinar>true</enable_webinar>
			<webinar_capacity>100</webinar_capacity>
			<enable_large>false</enable_large>
			<large_capacity>0</large_capacity>
			<disable_feedback>false</disable_feedback>
			<disable_jbh_reminder>false</disable_jbh_reminder>
			<enable_breakout_room>false</enable_breakout_room>
			<dept>Engineer</dept >
			<timezone>America/Los_Angeles</timezone>
			<lastClientVersion></lastClientVersion>
			<lastLoginTime></lastLoginTime>
			<token></token>
			<zpk></zpk>
		</user>
		...
	</users>
</result>

Response JSON:

{
	"page_count": 5,
	"total_records": 235,
	"page_number": 1,
	"page_size": 50,
	"users": [
	{
		"email": "test@abc.com ",
		"id": "dsfs23css23",
		"created_at": "2012-11-25T12:00:00Z",
		"first_name": "Lucy",
		"last_name": "Li",
		"type": 1,
		"pic_url": "https://www.zoom.us/p/bNsPi", 
		"disable_chat": false,
		"enable_e2e_encryption": false,
		"enable_silent_mode": false,
		"disable_group_hd": false,
		"disable_recording": false,
		"enable_cmr":false,
		"enable_auto_recording":false,
		"enable_cloud_auto_recording":false,
		"verified": 0,
		"pmi": 0,
		"meeting_capacity": 0,
		"enable_webinar":true,
		"webinar_capacity":100,
		"enable_large":false,
		"large_capacity": 0,
		"disable_feedback":false,
		"disable_jbh_reminder": true,
		"enable_breakout_room": false,
		"dept":"Engineer",
		"timezone": "America/Los_Angeles",
		"lastClientVersion": "",
		"lastLoginTime": "",
		"token":"",
		"zpk":""
	},
	{
		"email": "test2@abc.com ",
		"id": "dsfs23css23",
		"created_at": "2012-11-25T12:00:00Z",
		"first_name": "Lily",
		"last_name": "Sun",
		"type": 2,
		"pic_url": "https://www.zoom.us/p/bNsPi", 
		"disable_chat": false,
		"enable_e2e_encryption": false,
		"enable_silent_mode": false,
		"disable_group_hd": false,
		"disable_recording": false,
		"enable_cmr":false,
		"enable_auto_recording":false,
		"enable_cloud_auto_recording":false,
		"verified": 0,
		"pmi": 0,
		"meeting_capacity": 0,
		"enable_webinar":true,
		"webinar_capacity":100,
		"enable_large":false,
		"large_capacity": 0,
		"disable_feedback":false,
		"disable_jbh_reminder": true,
		"enable_breakout_room": false,
		"dept":"Engineer",
		"timezone": "America/Los_Angeles",
		"lastClientVersion": "",
		"lastLoginTime": "",
		"token":"",
		"zpk":""
	}
	...
	]
}

Note: The API will not respond actual values for the following fields due to user privacy policy:

disable_chat
enable_e2e_encryption
enable_silent_mode
disable_group_hd
verified
pmi

Get a user on Zoom via user id, return the user info.

Endpoint:

https://api.zoom.us/v1/user/get

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=user_id' https://api.zoom.us/v1/user/get

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<email>test@abc.com</email>
	<account_id>8af3444232345</account_id>
	<id>dsfs23css23</id>
	<created_at>2012-11-25T12:00:00Z</created_at>
	<type>1</type>
	<first_name>Lucy </first_name>
	<last_name>Li</last_name>
	<token>dSxJbaYvpRX3SWPmz_3Q…MxNzMyZTFhYg</token>
	<pic_url>https://www.zoom.us/p/aPsPi</pic_url>
	<disable_chat>false </disable_chat>
	<enable_e2e_encryption>false</enable_e2e_encryption>
	<enable_silent_mode>false</enable_silent_mode>
	<disable_group_hd>false</disable_group_hd>
	<disable_recording>false</disable_recording>
	<enable_cmr>false</ enable_cmr>
	<enable_auto_recording>false</ enable_auto_recording>
	<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
	<verified>1</verified>
	<pmi>2035134243</pmi>
	<vanity_url>https://zoom.us/my/testname</vanity_url>
	<meeting_capacity>0</meeting_capacity>
	<enable_webinar>true</enable_webinar>
	<webinar_capacity>100</webinar_capacity>
	<enable_large>false</enable_large>
	<large_capacity>0</large_capacity>
	<disable_feedback>false</disable_feedback>
	<disable_jbh_reminder>false</disable_jbh_reminder>
	<enable_breakout_room>true</enable_breakout_room>
	<dept>Engineer</dept >
	<timezone>America/Los_Angeles</timezone>
	<lastClientVersion>3.5.44664.0321(mac)</lastClientVersion>
	<lastLoginTime>2016-03-23T09:54:41Z</lastLoginTime>
	<token>adlfjadslfkjasdkljfkjalkadfskjdsafkjdfsajkllajsdfaljsdf</token>
	<zpk>JMsnh8uHMhxRki3C8AEqNmph2VE45R33y8lDK96MMfk.BwYAAAFTY-3PlgAAHCAkNDAwOGRjZTgtZmFiYi00MTg2LWJmYTctNmI4MmNjN2VjZTY0FlYydzlQTzgxUl8yS1pmREtvTWVybVEWVjJ3OVBPODFSXzJLWmZES29NZXJtUQxzb3BoaWUgc3VuNjZkALM0VUVtMTFHTmh3cGFTWlJNMGkxYjhXSXNIZEIzbXZ0VlZwOGg0Q1Jhb1B3LkJnSWdUMjlLVG1KR1YySjNTVnBDZDFwUlpXb3Zhamh1TUUwd2VVVkVaU3QyTDNCQVpUSTNabVJtWkRNNFpqSmhZall5TXpRMk9XVTVOMkUwT1RNeVlUa3lPV1UyTlRnMk5qTm1OV0prT0RVek5URmhNR1l5WTJObVpUTTVNV0V6TTJabU1RQQAAFi1YZ0gzWVg2VDNTZmRqVEI5dEJLMXcAAgE</zpk>
</result >

Response JSON:

{
	"email": "test@abc.com ",
	"id": "dsfs23css23",
	"account_id":"8af3444232345",
	"created_at": "2012-11-25T12:00:00Z",
	"first_name": "Lucy",
	"last_name": "Li",
	"type": 1,
	"token": "dSxJbaYvpRX3SWPmz_3QTpa…MyZTFhYg",
	"pic_url": "https://www.zoom.us/p/bNsPi", 
	"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,
	"vanity_url": "https://zoom.us/my/test",
	"meeting_capacity": 0,
	"enable_webinar":true,
	"webinar_capacity":100,
	"enable_large":false,
	"large_capacity": 0,
	"disable_feedback":false,
	"disable_jbh_reminder": true,
	"enable_breakout_room": true,
	"dept":"Engineer",
	"timezone": "America/Los_Angeles",
	"lastClientVersion": "3.5.44664.0321(mac)",
	"lastLoginTime": "2016-03-23T09:54:41Z",
	"token":"adlfjadslfkjasdkljfkjalkadfskjdsafkjdfsajkllajsdfaljsdf",
	"zpk": "ABzyF_DKLzVcPd-5Wu6zCwlZ3978jn7ZcTHONHrP7Vs.BwYAAAFTY-4XnwAAHCAkMTRlMzRjYzUtMjJmZC00MTQ1LTg2MzUtZmVmYjk3ZDI0NGMyFlYydzlQTzgxUl8yS1pmREtvTWVybVEWVjJ3OVBPODFSXzJLWmZES29NZXJtUQxzb3BoaWUgc3VuNjZkALM0VUVtMTFHTmh3cGFTWlJNMGkxYjhXSXNIZEIzbXZ0VlZwOGg0Q1Jhb1B3LkJnSWdUMjlLVG1KR1YySjNTVnBDZDFwUlpXb3Zhamh1TUUwd2VVVkVaU3QyTDNCQVpUSTNabVJtWkRNNFpqSmhZall5TXpRMk9XVTVOMkUwT1RNeVlUa3lPV1UyTlRnMk5qTm1OV0prT0RVek5URmhNR1l5WTJObVpUTTVNV0V6TTJabU1RQQAAFi1YZ0gzWVg2VDNTZmRqVEI5dEJLMXcAAgE"
}

Note: The response "token" variable can be used to generate start meeting zoomus protocol URL.

Get a user on Zoom via user email address and login type, return the user info.

Endpoint:

https://api.zoom.us/v1/user/getbyemail

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&email=user@email.com&login_type=100' https://api.zoom.us/v1/user/getbyemail

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
	<result>
	<email>test@abc.com</email>
	<id>dsfs23css23</id>
	<created_at>2012-11-25T12:00:00Z</created_at>
	<type>1</type>
	<first_name>Lucy </first_name>
	<last_name>Li</last_name>
	<token>dSxJbaYvpRX3SWPmz_3Q…MxNzMyZTFhYg</token>
	<pic_url>https://www.zoom.us/p/aPsPi</pic_url>
	<disable_chat>false </disable_chat>
	<enable_e2e_encryption>false</enable_e2e_encryption>
	<enable_silent_mode>false</enable_silent_mode>
	<disable_group_hd>false</disable_group_hd>
	<disable_recording>false</disable_recording>
	<enable_cmr>false</ enable_cmr>
	<enable_auto_recording>false</ enable_auto_recording>
	<enable_cloud_auto_recording>false</ enable_cloud_auto_recording>
	<verified>1</verified>
	<pmi>2035134243</pmi>
	<vanity_url>https://zoom.us/my/testname</vanity_url>
	<meeting_capacity>0</meeting_capacity>
	<enable_webinar>true</enable_webinar>
	<webinar_capacity>100</webinar_capacity>
	<enable_large>false</enable_large>
	<large_capacity>0</large_capacity>
	<disable_feedback>false</disable_feedback>
	<disable_jbh_reminder>false</disable_jbh_reminder>
	<enable_breakout_room>true</enable_breakout_room>
	<dept>Engineer</dept >
	<lastClientVersion>3.5.44664.0321(mac)</lastClientVersion>
	<lastLoginTime>2016-03-23T09:54:41Z</lastLoginTime>
	<token>adlfjadslfkjasdkljfkjalkadfskjdsafkjdfsajkllajsdfaljsdf</token>
	<zpk>JMsnh8uHMhxRki3C8AEqNmph2VE45R33y8lDK96MMfk.BwYAAAFTY-3PlgAAHCAkNDAwOGRjZTgtZmFiYi00MTg2LWJmYTctNmI4MmNjN2VjZTY0FlYydzlQTzgxUl8yS1pmREtvTWVybVEWVjJ3OVBPODFSXzJLWmZES29NZXJtUQxzb3BoaWUgc3VuNjZkALM0VUVtMTFHTmh3cGFTWlJNMGkxYjhXSXNIZEIzbXZ0VlZwOGg0Q1Jhb1B3LkJnSWdUMjlLVG1KR1YySjNTVnBDZDFwUlpXb3Zhamh1TUUwd2VVVkVaU3QyTDNCQVpUSTNabVJtWkRNNFpqSmhZall5TXpRMk9XVTVOMkUwT1RNeVlUa3lPV1UyTlRnMk5qTm1OV0prT0RVek5URmhNR1l5WTJObVpUTTVNV0V6TTJabU1RQQAAFi1YZ0gzWVg2VDNTZmRqVEI5dEJLMXcAAgE</zpk>
</result >

Response JSON:

{
	"email": "test@abc.com ",
	"id": "dsfs23css23",
	"created_at": "2012-11-25T12:00:00Z",
	"first_name": "Lucy",
	"last_name": "Li",
	"type": 1,
	"token": "dSxJbaYvpRX3SWPmz_3QTpa…MyZTFhYg",
	"pic_url": "https://www.zoom.us/p/bNsPi", 
	"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,
	"vanity_url": "https://zoom.us/my/test",
	"meeting_capacity": 0,
	"enable_webinar":true,
	"webinar_capacity":100,
	"enable_large":false,
	"large_capacity": 0,
	"disable_feedback":false,
	"disable_jbh_reminder": true,
	"enable_breakout_room": true,
	"dept": "Engineer",
	"lastClientVersion": "3.5.44664.0321(mac)",
	"lastLoginTime": "2016-03-23T09:54:41Z",
	"token":"adlfjadslfkjasdkljfkjalkadfskjdsafkjdfsajkllajsdfaljsdf",
	"zpk": "ABzyF_DKLzVcPd-5Wu6zCwlZ3978jn7ZcTHONHrP7Vs.BwYAAAFTY-4XnwAAHCAkMTRlMzRjYzUtMjJmZC00MTQ1LTg2MzUtZmVmYjk3ZDI0NGMyFlYydzlQTzgxUl8yS1pmREtvTWVybVEWVjJ3OVBPODFSXzJLWmZES29NZXJtUQxzb3BoaWUgc3VuNjZkALM0VUVtMTFHTmh3cGFTWlJNMGkxYjhXSXNIZEIzbXZ0VlZwOGg0Q1Jhb1B3LkJnSWdUMjlLVG1KR1YySjNTVnBDZDFwUlpXb3Zhamh1TUUwd2VVVkVaU3QyTDNCQVpUSTNabVJtWkRNNFpqSmhZall5TXpRMk9XVTVOMkUwT1RNeVlUa3lPV1UyTlRnMk5qTm1OV0prT0RVek5URmhNR1l5WTJObVpUTTVNV0V6TTJabU1RQQAAFi1YZ0gzWVg2VDNTZmRqVEI5dEJLMXcAAgE"
}

Note:The response "token" variable can be used to generate start meeting zoomus protocol URL.

Update user info on Zoom via user id.

Note: Email can't be changed in this call.

Endpoint:

https://api.zoom.us/v1/user/update

Parameters:

 

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=user_id' https://api.zoom.us/v1/user/update

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<id>dsfs23css23</id>
	<updated_at>2012-11-25T12:00:00Z</updated_at>
</result >

Response JSON:

{
	"id": "dsfs23css23",
	"updated_at": "2012-11-25T12:00:00Z"
}

Update user's password on Zoom via user id.

Note: Only users registered with work email can be updated in this call.

Endpoint:

https://api.zoom.us/v1/user/updatepassword

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&password=password123&id=user_id' https://api.zoom.us/v1/user/updatepassword

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
    <result>
    <id>dsfs23css23</id>
    <updated_at>2013-09-02T12:00:00Z</updated_at>
</result>

Response JSON:

{
    "id": "dsfs23css23",
    "updated_at": "2013-09-02T12:00:00Z"
}

Set a user’s assistant which can schedule meeting for him.

Precondition: Paid account ,Both host and assistant are Pro or Corp user.

Endpoint:

https://api.zoom.us/v1/user/assistant/set

Parameters:

cURL Example:
curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=user_id&assistant_email=assistant@email.com' https://api.zoom.us/v1/user/assistant/set
 

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>Hl3MV5rPQCiC8W6sMSTtLQ</id>
    <host_email>host@zoom.us</ host_email>
    <assistant_email> assistant@zoom.us</assistant_email>
    <updated_at>2013-09-02T12:00:00Z</updated_at>
</result>

Response JSON:

{
    "id": "4J0JY-qASouMJP65i8nZgg",
    "host_email": "host@zoom.us ",
    "updated_at": "2013-09-02T12:00:00Z"
}

Delete a user's assistant.

Endpoint:

https://api.zoom.us/v1/user/assistant/delete

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=user_id' https://api.zoom.us/v1/user/assistant/delete

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>Hl3MV5rPQCiC8W6sMSTtLQ</id>
    <host_email>host@zoom.us</ host_email>
    <updated_at>2013-09-02T12:00:00Z</updated_at>
</result>

Response JSON:

{
    "id": "4J0JY-qASouMJP65i8nZgg",
    "host_email": "host@zoom.us ",
    "updated_at": "2013-09-02T12:00:00Z"
}

Revoke a user's SSO token.

Endpoint:

https://api.zoom.us/v1/user/revoketoken

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=user_id' https://api.zoom.us/v1/user/revoketoken

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>Hl3MV5rPQCiC8W6sMSTtLQ</id>
    <email>host@zoom.us</email>
    <updated_at>2013-09-02T12:00:00Z</updated_at>
</result>

Response JSON:

{
    "id": "4J0JY-qASouMJP65i8nZgg",
    "email": "host@zoom.us ",
    "updated_at": "2013-09-02T12:00:00Z"
}

Delete a user from Zoom system permanently.

Note: SSO user can be re-created if re-login from SSO site is successful.

Endpoint:

https://api.zoom.us/v1/user/permanentdelete

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=user_id' https://api.zoom.us/v1/user/permanentdelete

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>Hl3MV5rPQCiC8W6sMSTtLQ</id>
    <email>host@zoom.us</email>
    <deleted_at>2013-09-02T12:00:00Z</deleted_at>
</result>

Response JSON:

{
    "id": "4J0JY-qASouMJP65i8nZgg",
    "email": "host@zoom.us ",
    "deleted_at": "2013-09-02T12:00:00Z"
}

Upload and update user's profile picture on Zoom via user Id.

Endpoint:

https://api.zoom.us/v1/user/uploadpicture

Parameters:

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>dsfs23css23</id>
    <updated_at>2013-09-02T12:00:00Z</updated_at>
</result>

Response JSON:

{
    "id": "dsfs23css23",
    "updated_at": "2013-09-02T12:00:00Z"
}

Note: Must use “multipart/form-data” to upload user profile picture.

Java Code Example:

File file = new File("d:\\your_photo.jpg");
HttpClient httpClient = new HttpClient();
PostMethod post = new PostMethod(“https://api.zoom.us/v1/user/uploadpicture”);
StringPart p1 = new StringPart(“api_key”, YOUR_API_KEY);
StringPart p2 = new StringPart(“api_secret”, YOUR_API_SECRET);
StringPart p3 = new StringPart(“data_type”, “JSON”);
StringPart p4 = new StringPart("id", userId);
FilePart fp = new FilePart("pic_file", file);
Part[] parts = new Part[]{p1, p2, p3, p4, fp};
MultipartRequestEntity requestEntity = new MultipartRequestEntity(parts, post.getParams());
post.setRequestEntity(requestEntity);
try {
    HttpConnectionManagerParams managerParams = httpClient.getHttpConnectionManager().getParams(); 
    managerParams.setConnectionTimeout(120000); // connection timeout: 2 minutes
    managerParams.setSoTimeout(120000); // socket read timeout: 2 minutes
    
    int statusCode = httpClient.executeMethod(post);
    String response = post.getResponseBodyAsString();
    if (statusCode == HttpStatus.SC_OK) {
        System.out.println("REST API response: " + response);
        return response;
    } else {
        System.out.println("REST API error: status=" + statusCode + ", response=" + response);
    }
} catch (Exception e) {
    e.printStackTrace();
} finally {
    post.releaseConnection();
}

Check if the user email exists.

Endpoint:

https://api.zoom.us/v1/user/checkemail

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&email=user@email.com' https://api.zoom.us/v1/user/checkemail

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
	<existed_email>true</existed_email>
</result>

Response JSON:

{
"existed_email": true/false,
}

Check if the zpk is expired. The zpk is used to authenticate a user.

Endpoint:

https://api.zoom.us/v1/user/checkzpk

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&zpk=zpk_token' https://api.zoom.us/v1/user/checkzpk

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
	< expire_in>7187</ expire_in>
</result >

Response JSON:

{
	" expire_in": 7187
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk