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.

External Documentation

To learn more, visit the PagerDuty documentation.

​
Basic Parameters

ParameterDescription
IncludeArray of additional Models to include in response.
QueryFilters the result, showing only the tags whose labels match the query.
Team IDsAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

​
Advanced Parameters

ParameterDescription
LimitThe number of results per page.
OffsetOffset to start pagination search results.
TotalBy 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 for more information.

​
Example Output

{
	"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

Preview this Workflow on desktop

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.

External Documentation

To learn more, visit the PagerDuty documentation.

​
Basic Parameters

ParameterDescription
IncludeArray of additional Models to include in response.
QueryFilters the result, showing only the tags whose labels match the query.
Team IDsAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

​
Advanced Parameters

ParameterDescription
LimitThe number of results per page.
OffsetOffset to start pagination search results.
TotalBy 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 for more information.

​
Example Output

{
	"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

Preview this Workflow on desktop