> ## 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 of your PagerDuty account, optionally filtered by a search query.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users).

<Note>
  External Documentation

  To learn more, visit the [PagerDuty documentation](https://developer.pagerduty.com/api-reference/c96e889522dd6-list-users).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter | Description                                                                                                                              |
  | --------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
  | Include   | Array of additional Models to include in response.                                                                                       |
  | Query     | Filters the result, showing only the tags whose labels match the query.                                                                  |
  | Team IDs  | An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter | Description                                                                                                                                                                                                                                                                               |
  | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Limit     | The number of results per page.                                                                                                                                                                                                                                                           |
  | Offset    | Offset to start pagination search results.                                                                                                                                                                                                                                                |
  | Total     | By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. |
</div>

## Example Output

```json theme={"dark"}
{
	"summary": "Response Example",
	"value": {
		"limit": 25,
		"more": false,
		"offset": 0,
		"total": null,
		"users": [
			{
				"avatar_url": "https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm\u0026r=PG",
				"color": "green",
				"contact_methods": [
					{
						"id": "PTDVERC",
						"self": "https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC",
						"summary": "Default",
						"type": "email_contact_method_reference"
					}
				],
				"description": "I'm the boss",
				"email": "125.greenholt.earline@graham.name",
				"html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
				"id": "PXPGF42",
				"invitation_sent": false,
				"job_title": "Director of Engineering",
				"name": "Earline Greenholt",
				"notification_rules": [
					{
						"html_url": null,
						"id": "P8GRWKK",
						"self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",
						"summary": "Default",
						"type": "assignment_notification_rule_reference"
					}
				],
				"role": "admin",
				"self": "https://api.pagerduty.com/users/PXPGF42",
				"summary": "Earline Greenholt",
				"teams": [
					{
						"html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8",
						"id": "PQ9K7I8",
						"self": "https://api.pagerduty.com/teams/PQ9K7I8",
						"summary": "Engineering",
						"type": "team_reference"
					}
				],
				"time_zone": "America/Lima",
				"type": "user"
			},
			{
				"avatar_url": "https://secure.gravatar.com/avatar/47857d059adacf9a41dc4030c2e14b0a.png?d=mm\u0026r=PG",
				"color": "red",
				"contact_methods": [
					{
						"id": "PVMGSML",
						"self": "https://api.pagerduty.com/users/PAM4FGS/contact_methods/PVMGSMLL",
						"summary": "Work",
						"type": "email_contact_method_reference"
					}
				],
				"description": "Actually, I am the boss",
				"email": "126_dvm_kyler_kuhn@beahan.name",
				"html_url": "https://subdomain.pagerduty.com/users/PAM4FGS",
				"id": "PAM4FGS",
				"invitation_sent": false,
				"job_title": "Senior Engineer",
				"name": "Kyler Kuhn",
				"notification_rules": [
					{
						"html_url": null,
						"id": "P8GRWKK",
						"self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",
						"summary": "Default",
						"type": "assignment_notification_rule_reference"
					}
				],
				"role": "admin",
				"self": "https://api.pagerduty.com/users/PAM4FGS",
				"summary": "Kyler Kuhn",
				"teams": [
					{
						"html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8",
						"id": "PQ9K7I8",
						"self": "https://api.pagerduty.com/teams/PQ9K7I8",
						"summary": "Engineering",
						"type": "team_reference"
					}
				],
				"time_zone": "Asia/Hong_Kong",
				"type": "user"
			}
		]
	}
}
```

## Workflow Library Example

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