> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Users

Use this API to list your account's users.

**Scopes:** `user:read:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`.

<Note>
  External Documentation

  To learn more, visit the [Zoom documentation](https://developers.zoom.us/docs/api/users/#tag/users/get/users).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter        | Description                                                                                                                                                                                                                                                                                |
  | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | Include Fields   | Use this parameter to display one of the following attributes in the API call's response: <br />\* `custom_attributes` — Return the user's custom attributes. <br />\* `host_key` — Return the user's [host key](https://support.zoom.us/hc/en-us/articles/205172555-Using-your-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 by<br />a specific role. You can use the [List roles](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#operation/roles)<br />API to get a role's unique ID value.                                           |
  | Status           | The user's status: <br />\* `active` — An active user. <br />\* `inactive` — A deactivated user. <br />\* `pending` — A pending user.<br /><br />This value defaults to `active`.                                                                                                          |
</div>

## Advanced Parameters

<div className="integrations-table">
  | 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.                                                                                                                                                                   |
</div>

## Example Output

```json theme={"dark"}
{
  "page_count": 2,
  "page_number": 2,
  "page_size": 14,
  "total_records": 5,
  "next_page_token": "<string>",
  "users": [
    {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "display_name": "<string>",
      "email": "<string>",
      "type": 6,
      "timezone": "<string>",
      "verified": 0,
      "dept": "<string>",
      "created_at": "2020-04-01T16:47:52Z",
      "pic_url": "<string>",
      "group_ids": [
        "<string>"
      ],
      "language": "<string>",
      "phone_number": "<string>",
      "status": "<string>",
      "role_id": "<string>",
      "employee_unique_id": "<string>",
      "user_created_at": "2020-04-01T16:47:52Z",
    },
    {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "display_name": "<string>",
      "email": "<string>",
      "type": 0,
      "pmi": 2,
      "verified": 1,
      "dept": "<string>",
      "created_at": "2020-04-01T16:47:52Z",
      "language": "<string>",
      "status": "<string>",
      "role_id": "<string>",
      "employee_unique_id": "<string>",
      "user_created_at": "2020-04-01T16:47:52Z",
    }
  ]
}
```

## Workflow Library Example

[List Users with Zoom and Send Results Via Email](https://library.blinkops.com/workflows/list-users-with-zoom-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-users-with-zoom-and-send-results-via-email/canvas" />
</div>