GET /notifications
List notifications for a given time range, optionally filtered by type (sms_notification, email_notification, phone_notification, or push_notification).
A Notification is created when an Incident is triggered or escalated.
For more information see the API Concepts Document
Scoped OAuth requires: users:notifications.read
Servers
- https://api.pagerduty.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The Default value: "application/vnd.pagerduty+json;version=2" |
Content-Type |
String | Yes |
Possible values:
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. |
limit |
Integer | No |
The number of results per page. |
include |
String | No |
Array of additional details to include. Possible values:
|
filter |
String | No |
Return notification of this type only. Possible values:
|
until |
String | Yes |
The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months. |
since |
String | Yes |
The start of the date range over which you want to search. The time element is optional. |
offset |
Integer | No |
Offset to start pagination search results. |
total |
Boolean | No |
By default the See our Pagination Docs for more information. Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.