List users on call.

List all of the users on call in a given schedule for a given time range.

A Schedule determines the time periods that users are On-Call.

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

Path Parameters

id*string

The ID of the schedule.

Query Parameters

since?string

The start of the date range over which you want to search.

Formatdate-time

until?string

The end of the date range over which you want to search.

Formatdate-time

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://example.com/schedules/P2LJD7G/users" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json"

{  "users": [    {      "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://secure.gravatar.com/avatar/47857d059adacf9a41dc4030c2e14b0a.png?d=mm&r=PG",      "description": "Engineer based in HK",      "invitation_sent": 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": "P8GRWKZ",          "type": "assignment_notification_rule_reference",          "summary": "Default",          "self": "https://api.pagerduty.com/users/PAM4FGS/notification_rules/P8GRWKZ",          "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"        }      ]    },    {      "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://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG",      "description": "I'm the boss",      "invitation_sent": false,      "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"        }      ]    }  ]}

List users on call.

Authorization

Path Parameters

Query Parameters

Header Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`