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

List users with given parameters.

<Note>
  External Documentation

  To learn more, visit the [Opsgenie documentation](https://www.opsgenie.com/docs/user-api#section-list-user).
</Note>

## Parameters

<div className="integrations-table">
  | Parameter  | Description                                                                                                                                                                                     |
  | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Limit      | Number of users to retrieve.                                                                                                                                                                    |
  | Offset     | Number of users to skip from start.                                                                                                                                                             |
  | Order      | Direction of sorting. Should be one of 'asc' or 'desc'.                                                                                                                                         |
  | Query      | Field:value combinations with most of user fields to make more advanced searches. Possible fields are username, fullName, blocked, verified, role, locale, timeZone, userAddress and createdAt. |
  | Sort Field | Field to use in sorting. Should be one of 'username', 'fullName' and 'insertedAt'.                                                                                                              |
</div>

## Example Output

```json theme={"dark"}
{
	"data": [
		{
			"blocked": false,
			"createdAt": "date-time",
			"details": {},
			"fullName": "string",
			"id": "string",
			"locale": "Location information of the user. If not set, locale of the customer will be used instead.",
			"mutedUntil": "date-time",
			"role": {
				"id": "string",
				"name": "string"
			},
			"skypeUsername": "Skype username of the user",
			"tags": [
				"string"
			],
			"timeZone": "Timezone of the user. If not set, timezone of the customer will be used instead.",
			"userAddress": {
				"city": "string",
				"country": "string",
				"line": "string",
				"state": "string",
				"zipCode": "string"
			},
			"userContacts": [
				{
					"contactMethod": "string",
					"disabledReason": "string",
					"enabled": false,
					"id": "string",
					"to": "string"
				}
			],
			"username": "string",
			"verified": false
		}
	],
	"paging": {
		"first": "string",
		"last": "string",
		"next": "string",
		"prev": "string"
	},
	"requestId": "string",
	"took": 0,
	"totalCount": 0
}
```

## Workflow Library Example

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