> ## 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

Retrieve a list of users.

<Note>
  External Documentation

  To learn more, visit the [Zscaler Authentication Service documentation](https://automate.zscaler.com/docs/api-reference-and-guides/api-reference/zid/users/users-ops-list).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter             | Description                                                                        |
  | --------------------- | ---------------------------------------------------------------------------------- |
  | Display Name Contains | The display name to filter the results by, using a case-insensitive partial match. |
  | Limit                 | The maximum number of records to return per request. The maximum value is `1000`.  |
  | Login Name            | A comma-separated list of login names to filter the results by.                    |
  | Login Name Contains   | The login name to filter the results by, using a case-insensitive partial match.   |
  | Offset                | The offset from which to start returning results.                                  |
  | Return All Pages      | Automatically fetch all resources, page by page.                                   |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter              | Description                                                                         |
  | ---------------------- | ----------------------------------------------------------------------------------- |
  | Domain Name            | A comma-separated list of domain names to filter the results by.                    |
  | IdP Name               | A comma-separated list of identity provider names to filter the results by.         |
  | Primary Email Contains | The primary email to filter the results by, using a case-insensitive partial match. |
</div>

## Example Output

```json theme={"dark"}
{
	"pageOffset": 1,
	"pageSize": 1,
	"totalRecord": 11,
	"records": [
		{
			"loginName": "john.doe@example.com",
			"displayName": "John",
			"firstName": "John",
			"lastName": "Doe",
			"primaryEmail": "john.doe@example.com",
			"department": {},
			"status": true,
			"customAttrsInfo": {},
			"id": "abc123def456g",
			"source": "EXAMPLE_SOURCE",
			"idp": {
				"id": "xyz789uvw012m",
				"name": "Example IdP"
			}
		}
	],
	"next_link": "https://example-admin.example.com/admin/api/v1/users?limit=1&offset=2",
	"prev_link": "https://example-admin.example.com/admin/api/v1/users?limit=1&offset=0",
	"results_total": 11
}
```

## Workflow Library Example

[List Users with Zscaler Authentication Service and Send Results Via Email](https://library.blinkops.com/workflows/list-users-with-zscaler-authentication-service-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-zscaler-authentication-service-and-send-results-via-email/canvas" />
</div>