younifyd
Menu

List Incidents

List incidents

GET/incidents

Use it in a workflow

  1. Add a step and choose the PagerDuty connector.
  2. Pick the List Incidents action (under Incidents).
  3. Fill in the fields below, then reference the result from later steps as {{listIncidents.response.data}}.

Request

Query parameters

limitinteger

The number of results per page. Maximum of 100.

offsetinteger

Offset to start pagination search results.

totalboolean

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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.

Default false

date_rangestring

When set to all, the since and until parameters and defaults are ignored.

One ofall

incident_keystring

Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key.

service_ids[]array<string>

Returns only the incidents associated with the passed service(s). This expects one or more service IDs.

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.

user_ids[]array<string>

Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.

urgencies[]string

Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this.

One ofhighlow

time_zonestring (tzinfo)

Time zone in which results will be rendered. This will default to the account time zone.

statuses[]string

Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)

One oftriggeredacknowledgedresolved

sort_byarray<string>

Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency.

include[]string

Array of additional details to include.

One ofacknowledgersagentsassigneesconference_bridgeescalation_policiesfirst_trigger_log_entriesprioritiesservicesteamsusers

sincestring

The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month.

untilstring

The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month.

Headers

Acceptstringrequired

The `Accept` header is used as a versioning header.

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

Content-Typestringrequired

One ofapplication/jsonDefault "application/json"

Response

Returns 200 with a any. Read it in later steps with {{listIncidents.response.data.<field>}}.

Need more? See the PagerDuty guide for connection setup and behaviour shared by every action.