Actions
List Users
Use this API to list your account’s users.
Scopes: user:read:admin
Rate Limit Label: Medium
.
Basic Parameters
Parameter | Description |
---|---|
Include Fields | 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. | | Page Size | The number of records returned within a single API call. | | Return All Pages | Automatically fetch all resources, page by page. | | Role ID | The role’s unique ID. Use this parameter to filter the response bya specific role. You can use the List rolesAPI to get a role’s unique ID value. | | Status | The user’s status:-active
— An active user.inactive
— A deactivated user.pending
— A pending user.This value defaults toactive
. |
Advanced Parameters
Parameter | Description |
---|---|
Next Page Token | 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. |
Page Number | The page number of the current page in the returned records. |
Example Output
Workflow Library Example
List Users with Zoom and Send Results Via Email
Preview this Workflow on desktop