GET /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: Medium

Servers

https://api.zoom.us/v2

Query parameters

Name	Type	Required	Description
`page_number`	String	No	The page number of the current page in the returned records.
`page_size`	Integer	No	The number of records returned within a single API call. Default value: 30
`role_id`	String	No	Unique identifier of 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 API.
`status`	String	No	User statuses: `active` - Users with an active status. `inactive` - Users who are deactivated. `pending` - Users with a pending status. Valid values: `"inactive"` `"active"` `"pending"` Default value: "active"
`next_page_token`	String	No	The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
`include_fields`	String	No	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. `host_key`: Returns host key of the user.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.