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

Scoped OAuth requires: users.read

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Query Parameters

query?string

Filters the result, showing only the records whose name matches the query.

team_ids[]?array<string>

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

limit?integer

The number of results per page.

offset?integer

Offset to start pagination search results.

total?boolean

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 for more information.

Defaultfalse

include[]?string

Array of additional Models to include in response.

Value in

"contact_methods"
"notification_rules"
"teams"
"subdomains"

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Response Body

`application/json`

curl -X GET "https://api.pagerduty.com/users" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json"

{  "users": [    {      "id": "PXPGF42",      "type": "user",      "summary": "Earline Greenholt",      "self": "https://api.pagerduty.com/users/PXPGF42",      "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",      "name": "Earline Greenholt",      "email": "125.greenholt.earline@graham.name",      "time_zone": "America/Lima",      "color": "green",      "role": "admin",      "avatar_url": "https://pd-static-assets.pagerduty.com/users/blank-avatar.png",      "description": "I'm the boss",      "invitation_sent": false,      "created_via_sso": true,      "contact_methods": [        {          "id": "PTDVERC",          "type": "email_contact_method_reference",          "summary": "Default",          "self": "https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC"        }      ],      "notification_rules": [        {          "id": "P8GRWKK",          "type": "assignment_notification_rule_reference",          "summary": "Default",          "self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",          "html_url": null        }      ],      "job_title": "Director of Engineering",      "teams": [        {          "id": "PQ9K7I8",          "type": "team_reference",          "summary": "Engineering",          "self": "https://api.pagerduty.com/teams/PQ9K7I8",          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"        }      ]    },    {      "id": "PAM4FGS",      "type": "user",      "summary": "Kyler Kuhn",      "self": "https://api.pagerduty.com/users/PAM4FGS",      "html_url": "https://subdomain.pagerduty.com/users/PAM4FGS",      "name": "Kyler Kuhn",      "email": "126_dvm_kyler_kuhn@beahan.name",      "time_zone": "Asia/Hong_Kong",      "color": "red",      "role": "admin",      "avatar_url": "https://pd-static-assets.pagerduty.com/users/blank-avatar.png",      "description": "Actually, I am the boss",      "invitation_sent": false,      "created_via_sso": false,      "contact_methods": [        {          "id": "PVMGSML",          "type": "email_contact_method_reference",          "summary": "Work",          "self": "https://api.pagerduty.com/users/PAM4FGS/contact_methods/PVMGSMLL"        }      ],      "notification_rules": [        {          "id": "P8GRWKK",          "type": "assignment_notification_rule_reference",          "summary": "Default",          "self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",          "html_url": null        }      ],      "job_title": "Senior Engineer",      "teams": [        {          "id": "PQ9K7I8",          "type": "team_reference",          "summary": "Engineering",          "self": "https://api.pagerduty.com/teams/PQ9K7I8",          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"        }      ]    }  ],  "limit": 25,  "offset": 0,  "more": false,  "total": null}

List users

Authorization

Query Parameters

Header Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`