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

To fetch all results, run repeatedly with the `Offset` parameter as long as the result metadata has a `next_offset` value.

If `Username` is not provided, the list will contain all users.

If `Username` is provided, the list will either contain a single user (if a match was found) or no users.

**Note**: This action requires the `Grant resource - Read` API permission.

<Note>
  External Documentation

  To learn more, visit the [Duo documentation](https://duo.com/docs/adminapi#retrieve-users).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter | Description                                                       |
  | --------- | ----------------------------------------------------------------- |
  | Username  | Specify a user name (or username alias) to look up a single user. |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter | Description                                                                                                                                                                                                        |
  | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | Limit     | The maximum number of records to retrieve. Defaults to `100`, with maximum value of `300`.                                                                                                                         |
  | Offset    | The offset from 0 at which to start record retrieval.<br /><br />When used with `Limit`, the handler will return `limit` records starting at the n-th record, where `n` is the offset.<br /><br />Defaults to `0`. |
</div>

## Example Output

```json theme={"dark"}
{
  "stat": "OK",
  "response": [
    {
      "alias1": "joe.smith",
      "alias2": "jsmith@example.com",
      "alias3": null,
      "alias4": null,
      "aliases": {
        "alias1": "joe.smith",
        "alias2": "jsmith@example.com"
      },
      "created": 1489612729,
      "email": "jsmith@example.com",
      "firstname": "Joe",
      "groups": [
        {
        "desc": "People with hardware tokens",
        "group_id": "DGXXXXXXXXXXXXXXXXX",
        "mobile_otp_enabled": false,
        "name": "token_users",
        "push_enabled": false,
        "sms_enabled": false,
        "status": "Active",
        "voice_enabled": false  
        }
      ],
      "is_enrolled": true,
      "last_directory_sync": 1508789163,
      "last_login": 1343921403,
      "lastname": "Smith",
      "notes": "",
      "phones": [
        {
        "activated": true,
        "capabilities": [
          "auto",
          "push",
          "sms",
          "phone",
          "mobile_otp"
        ],
        "encrypted": "Encrypted",
        "extension": "",
        "fingerprint": "Configured",
        "last_seen": "2019-11-18T15:51:13",
        "model": "Apple iPhone 11 Pro",
        "name": "My iPhone",
        "number": "15555550100",
        "phone_id": "DPFZRS9FB0D46QFTM899",
        "platform": "Apple iOS",
        "postdelay": "0",
        "predelay": "0",
        "screenlock": "Locked",
        "sms_passcodes_sent": true,
        "tampered": "Not tampered",
        "type": "Mobile"
        }
      ],
      "realname": "Joe Smith",
      "status": "active",
      "tokens": [
        {
        "serial": "123456",
        "token_id": "DHIZ34ALBA2445ND4AI2",
        "type": "d1"
        }
      ],
      "u2ftokens": [],
      "user_id": "DU3RP9I2WOC59VZX672N",
      "username": "jsmith",
      "webauthncredentials": [
        {
        "credential_name": "Touch ID",
        "date_added": 1550685154,
        "label": "Touch ID",
        "webauthnkey": "WABFEOE007ZMV1QAZTRB"
        },
        {
        "credential_name": "YubiKey C",
        "date_added": 1550674764,
        "label": "Security Key",
        "webauthnkey": "WA4BD9AUVMSNUFWZGES4"
        }
      ],
    }
  ]
}
```

## Workflow Library Example

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