|docs
Start Trial
REST API

List 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

Authorization

api_key
Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Query Parameters

limit?integer

The number of results per page.

offset?integer

Offset to start pagination search results.

total?boolean

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.

Defaultfalse
time_zone?string

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

Formattzinfo
since*string

The start of the date range over which you want to search. The time element is optional.

Formatdate-time
until*string

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.

Formatdate-time
filter?string

Return notification of this type only.

Value in

  • "sms_notification"
  • "email_notification"
  • "phone_notification"
  • "push_notification"
include[]?"users"

Array of additional details to include.

Value in

  • "users"

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"
Content-Type*"application/json"
Default"application/json"

Value in

  • "application/json"

Response Body

application/json

application/json

application/json

application/json

application/json

Update a maintenance window PUT

Update an existing maintenance window. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.write`

List notifications GET

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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#notifications) Scoped OAuth requires: `users:notifications.read`