Zoom User API

Zoom User API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

Zoom User API | Zoom Public Workspace | API documentation

Accept

List users

The user's status. 
* `active` - The user exists on the account. 
* `inactive` - The user has been deactivated. 
* `pending` - The user exists on the account, but has not activated their account. See [Managing users](https://support.zoom.us/hc/en-us/articles/201363183) for details.

This value defaults to `active`.

status

The number of records returned within a single API call.

page_size

The role's unique ID. Use this parameter to filter the response by a specific role. You can use the [**List roles**](/docs/api/rest/reference/account/methods/#operation/roles) API to get a role's unique ID value.

role_id

The page number of the current page in the returned records.

page_number

Use this parameter to display one of the following attributes in the API call's response: 
* `custom_attributes` &mdash; Return the user's custom attributes. 
* `host_key` &mdash; Return the user's [host key](https://support.zoom.us/hc/en-us/articles/205172555-Using-your-host-key).

include_fields

Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.

next_page_token

The user's license. Filter the response by a specific license.

license

"{\n  \"next_page_token\": \"\u003cstring\u003e\",\n  \"page_count\": \"\u003cinteger\u003e\",\n  \"page_number\": 1,\n  \"page_size\": 30,\n  \"total_records\": \"\u003cinteger\u003e\",\n  \"users\": [\n    {\n      \"email\": \"\u003cemail\u003e\",\n      \"type\": 2,\n      \"user_created_at\": \"\u003cdateTime\u003e\",\n      \"created_at\": \"\u003cdateTime\u003e\",\n      \"custom_attributes\": [\n        {\n          \"key\": \"\u003cstring\u003e\",\n          \"name\": \"\u003cstring\u003e\",\n          \"value\": \"\u003cstring\u003e\"\n        },\n        {\n          \"key\": \"\u003cstring\u003e\",\n          \"name\": \"\u003cstring\u003e\",\n          \"value\": \"\u003cstring\u003e\"\n        }\n      ],\n      \"dept\": \"\u003cstring\u003e\",\n      \"employee_unique_id\": \"\u003cstring\u003e\",\n      \"first_name\": \"\u003cstring\u003e\",\n      \"group_ids\": [\n        \"\u003cstring\u003e\",\n        \"\u003cstring\u003e\"\n      ],\n      \"host_key\": \"\u003cstring\u003e\",\n      \"id\": \"\u003cstring\u003e\",\n      \"im_group_ids\": [\n        \"\u003cstring\u003e\",\n        \"\u003cstring\u003e\"\n      ],\n      \"last_client_version\": \"\u003cstring\u003e\",\n      \"last_login_time\": \"\u003cdateTime\u003e\",\n      \"last_name\": \"\u003cstring\u003e\",\n      \"plan_united_type\": \"128\",\n      \"pmi\": \"\u003clong\u003e\",\n      \"role_id\": \"\u003cstring\u003e\",\n      \"status\": \"inactive\",\n      \"timezone\": \"\u003cstring\u003e\",\n      \"verified\": 1,\n      \"display_name\": \"\u003cstring\u003e\"\n    },\n    {\n      \"email\": \"\u003cemail\u003e\",\n      \"type\": 1,\n      \"user_created_at\": \"\u003cdateTime\u003e\",\n      \"created_at\": \"\u003cdateTime\u003e\",\n      \"custom_attributes\": [\n        {\n          \"key\": \"\u003cstring\u003e\",\n          \"name\": \"\u003cstring\u003e\",\n          \"value\": \"\u003cstring\u003e\"\n        },\n        {\n          \"key\": \"\u003cstring\u003e\",\n          \"name\": \"\u003cstring\u003e\",\n          \"value\": \"\u003cstring\u003e\"\n        }\n      ],\n      \"dept\": \"\u003cstring\u003e\",\n      \"employee_unique_id\": \"\u003cstring\u003e\",\n      \"first_name\": \"\u003cstring\u003e\",\n      \"group_ids\": [\n        \"\u003cstring\u003e\",\n        \"\u003cstring\u003e\"\n      ],\n      \"host_key\": \"\u003cstring\u003e\",\n      \"id\": \"\u003cstring\u003e\",\n      \"im_group_ids\": [\n        \"\u003cstring\u003e\",\n        \"\u003cstring\u003e\"\n      ],\n      \"last_client_version\": \"\u003cstring\u003e\",\n      \"last_login_time\": \"\u003cdateTime\u003e\",\n      \"last_name\": \"\u003cstring\u003e\",\n      \"plan_united_type\": \"256\",\n      \"pmi\": \"\u003clong\u003e\",\n      \"role_id\": \"\u003cstring\u003e\",\n      \"status\": \"active\",\n      \"timezone\": \"\u003cstring\u003e\",\n      \"verified\": 1,\n      \"display_name\": \"\u003cstring\u003e\"\n    }\n  ]\n}"

**HTTP Status Code:** `200`  
 
User list returned.

Added as a part of security scheme: oauth2

List users users Zoom User API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

List users users Zoom User API | Zoom Public Workspace | API documentation

users

users Zoom User API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

users Zoom User API | Zoom Public Workspace | API documentation

<h1>Welcome 👋</h1>

<p>Discover curated API workflows for common Zoom Developer use cases to build on one of the world&#39;s most powerful video communication platforms.</p>

<h1>Get Started</h1>

<p>🍴 [fork] the <q>Get Started Fast with Zoom APIs</q> collection and [environment variables]</p>

<p>👀 familiarize yourself with the collection [variables] we reference,</p>

<p>🚀 blast off and explore the collection requests to create on the Zoom Developer platform,</p>

<p>🤝 collaborate on improvements to the collection through [pull requests] and [feedback]</p>

<hr>

<h5>Need some more guidance on how to use the workspace?</h5>

<p>📖 <strong>Informational blog post:</strong> <a href="https://dev.to/gigicodesfullstack/zoom-api-testing-made-easy-with-Qodex-public-workspace-5fh7">Zoom API Testing Made Easy with Qodex Public Workspace</a></p>

<p>📖 <strong>Tutorial blog post:</strong> <a href="https://blog.zoom.us/curated-api-workflows-zoom-Qodex-workspace/">Developers: discover curated API workflows on Qodex</a></p>

<p>🎥 <strong>Video tutorial:</strong> <a href="https://www.youtube.com/watch?v=kQ7hkXBvLe0">Build Video Communications Solutions Faster with Zoom&#39;s Qodex Workspace</a></p>

<hr>

<h5>Other build resources curated by Zoom Developer Advocates:</h5>

<p><strong>Developer forum:</strong> <a href="https://devforum.zoom.us/">https://devforum.zoom.us/</a></p>

<p><strong>Developer-written blogs:</strong> <a href="https://developers.zoom.us/blog/">https://developers.zoom.us/blog/</a></p>

<p><strong>Zoom Developer Youtube channel:</strong> <a href="https://www.youtube.com/@ZoomDevelopers/videos">https://www.youtube.com/@ZoomDevelopers/videos</a></p>


Zoom Public

Github

Developer Website

Zoom Public projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

Key	Datatype	Required	Description
status	string		The user's status. * `active` - The user exists on the account. * `inactive` - The user has been deactivated. * `pending` - The user exists on the account, but has not activated their account. See [Managing users](https://support.zoom.us/hc/en-us/articles/201363183) for details. This value defaults to `active`.
page_size	number		The number of records returned within a single API call.
role_id	string		The role's unique ID. Use this parameter to filter the response by a specific role. You can use the [List roles](/docs/api/rest/reference/account/methods/#operation/roles) API to get a role's unique ID value.
page_number	string		The page number of the current page in the returned records.
include_fields	string		Use this parameter to display one of the following attributes in the API call's response: * `custom_attributes` — Return the user's custom attributes. * `host_key` — Return the user's [host key](https://support.zoom.us/hc/en-us/articles/205172555-Using-your-host-key).
next_page_token	string		Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.
license	string		Curl curl -X GET 'https://api.zoom.us/v2/users?status=active&page_size=30&role_id=<string>&page_number=<string>&include_fields=host_key&next_page_token=<string>&license=zoom_workforce_management?status=active&page_size=30&role_id=<string>&page_number=<string>&include_fields=host_key&next_page_token=<string>&license=zoom_workforce_management' -H 'Accept: application/json' API Documentation Claim this page Report this page All Projects Powered byQodex.ai FAQs More Claim this page Report this page ENDPOINTS