List Users

A Zoom account can have one or more users. Use this API to list users on your account.**Scopes:** user:read:admin ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Medium

listUsers(
  status = NULL,
  page_size = NULL,
  role_id = NULL,
  page_number = NULL,
  include_fields = NULL,
  return_response = F
)

Arguments

status	User statuses:active Users with an active status.inactive Users who are deactivated.pending Users with a pending status.
page_size	The number of records returned within a single API call.
role_id	Unique identifier for the role. Provide this parameter if you would like to filter the response by a specific role. You can retrieve Role IDs from List Roles https://marketplace.zoom.us/docs/apireference/zoomapi/roles/roles API.
page_number	The page number of the current page in the returned records.
include_fields	Provide a value for this field if you would like to see the following attribute in the response of this API call:custom_attributes: Returns custom attributes that are associated with the user.
return_response	Whether to return the response instead of the response content. Defaults to FALSE.

Arguments

Contents