Read Users On Call

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

Input

Field Definition Type Required

Schedule

Schedule ID Unique identifier of the schedule that will be read.

Text

TRUE

Since Start of the date range for the search.

For example, 2015-11-10T08:00:00-05:00.

Date & Time

FALSE

Until End of the date range for the search.

For example, 2015-11-10T17:00:00-05:00.

Date & Time

FALSE

Output

Field Definition Type

Users (List of Objects)

User ID

Unique identifier of the user.

Text

Name

Name of the user.

Text

Summary A short summary for the user. May be identical to Name, but it is not intended to be an identifier.

Text

Description A description of the user.

Text

Type

Type of data returned.

Text

Time Zone Preferred time zone name. If null, the account's time zone will be used.

Text

HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app.

Text

Color Schedule color.

Text

Role User role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access.

Text

Avatar URL URL of the user's avatar.

Text

Invitation Sent? If the user has an outstanding invitation, True; otherwise, False.

True/False

Billed? If the user was billed, True; otherwise, False.

True/False

Job Title User's title.

Text

Teams List of teams to which the user belongs.

List of Objects

Team ID Unique identifier for a team object.

Text

Summary A short summary for the team object. May be identical to Name, but it is not intended to be an identifier.

Text

Type A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Text

HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app.

Text

Contact Methods List of contact methods for the user.

List of Objects

Contact Method ID Unique identifier for a contact method.

Text

Summary A short summary for the contact method object. May be identical to Name, but it is not intended to be an identifier.

Text

Type A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Text

HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app.

Text

Notification Rules List of notification rules for the user.

List of Objects

Notification Rule ID Unique identifier for a notification rule.

Text

Summary A short summary for the notification rule object. May be identical to Name, but it is not intended to be an identifier.

Text

Type A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Text

HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app.

Text

Related topics

PagerDuty connector

Workflow elements

PagerDuty REST API