Sign in
Notifications

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

get/notifications

Query parameters

limitinteger

The number of results per page.

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 for more information.

time_zonestring tzinfo

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

sincestring date-time required

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

untilstring date-time required

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.

filter'sms_notification' | 'email_notification' | 'phone_notification' | 'push_notification'

Return notification of this type only.

include[]'users'

Array of additional details to include.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

A paginated array of notifications.

offsetinteger

Echoes offset pagination property.

limitinteger

Echoes limit pagination property.

moreboolean

Indicates if there are additional records to return

totalinteger nullable

The total number of records matching the given query.

notificationsNotification[] required— unresolved $ref

Changes