Logo
Zoom Public API Documentation

List users

GET {{baseUrl}}/users?status=active&page_size=30&role_id=<string>&page_number=<string>&include_fields=host_key&next_page_token=<string>&license=zoom_workforce_management

Retrieve a list your account's users.

Scopes: user:read:admin

Rate Limit Label: MEDIUM

 

Body PARAM

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` &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).
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'

ENDPOINTS