GET /incidents

List existing incidents.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the API Concepts Document

Scoped OAuth requires: incidents.read

Servers

Request headers

Name Type Required Description
Accept String Yes

The Accept header is used as a versioning header.

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

Content-Type String Yes

Possible values:

  • "application/json"

Default value: "application/json"

Query parameters

Name Type Required Description
time_zone String No

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

since String No

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

statuses String No

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.)

Possible values:

  • "triggered"
  • "resolved"
  • "acknowledged"
date_range String No

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

Possible values:

  • "all"
incident_key String No

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.

total Boolean No

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.

Default value: false

limit Integer No

The number of results per page. Maximum of 100.

include String No

Array of additional details to include.

Possible values:

  • "conference_bridge"
  • "users"
  • "assignees"
  • "first_trigger_log_entries"
  • "agents"
  • "priorities"
  • "services"
  • "escalation_policies"
  • "teams"
  • "acknowledgers"
service_ids[] Array No

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

until String No

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

urgencies String No

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

Possible values:

  • "high"
  • "low"
team_ids[] Array No

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 No

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.

sort_by[] Array No

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.

offset Integer No

Offset to start pagination search results.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.