Search Schedules

Search for schedules in your PagerDuty instance.

Options

Field	Definition	Type	Required
Result Set	Choose one of the following options to display your search results: First Matching Record: returns a single schedule First 100 Matching Records: returns the first 100 matching schedule records Stream Matching Records: pass all matching schedule records from your parent flow to a helper flow; a Streaming input section will be added to the card from which you can select a helper flow for streaming and adding custom extensible fields.	Dropdown	TRUE

Input

Field	Definition	Type	Required
Search By
Name	Full or partial strings used to query records based on a value in the schedule's Name field. For example, to search for the schedule name dgKyDNfmB3, any of the following are valid query terms: dgKyDNfmB3 KyDN>	Text	TRUE
Search Criteria
Records Limit	Specified maximum number of records that can be streamed. The minimum allowable value is 1; the maximum is 1,000,000. Records Limit input field is only available with the Stream Matching Records option.	Number	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow to which the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.	Flow	TRUE

Output

Field	Definition	Type
Schedules	List of schedules that match the search criteria.	Object
Schedule ID	Unique identifier of the schedule.	Text
Name	Name of the schedule.	Text
Summary	A short string that provides succinct, information about the schedule. In many cases, this will be identical to Name, though it is not intended to be an identifier.	Text
Description	A short description given to the schedule.	Text
Type	Type of data returned.	Text
Time Zone	Time zone of the schedule. Default is UTC.	Text
HTML URL	URL for the team profile in your PagerDuty instance.	Text
Escalation Policies (List of Objects)
Escalation Policy ID	Unique user identifier for the escalation policy.	Text
Summary	A short summary for the escalation policy 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
Users (List of Objects)
User ID	Unique identifier of the user.	Text
Summary	A short summary for the user 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
Teams (List of Objects)
Team ID	Unique user 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

Related topics

PagerDuty connector

Workflow elements

PagerDuty REST API