Skip to main content
GET
List my notifications

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

audience
enum<string>

Only organisation-wide notifications, or only the ones addressed to the caller.

Available options:
organisation,
user
state
enum<string>[]

Only notifications in these states (repeat the parameter for several).

Available options:
open,
acknowledged,
auto_resolved,
dismissed
kind
string[]

Only notifications of these kinds (repeat the parameter for several).

severity
enum<string>[]

Only notifications of these severities (repeat the parameter for several).

Available options:
critical,
warning,
info
unread_only
boolean
default:false

Only notifications the caller has not read.

subscribed_only
boolean
default:false

Only notifications of clusters the caller subscribes to, plus organisation-wide ones.

q
string

Free-text search over the title and body.

Maximum string length: 200
since
string<date-time>

Only notifications seen at or after this time.

page
integer
default:1

The page to return.

Required range: x >= 1
page_size
integer
default:25

Notifications per page.

Required range: 1 <= x <= 100
view
enum<string>

A notification centre view instead of the plain list.

Available options:
inbox,
needs_you,
history
before
string<date-time>

Cursor: only notifications before this time (with before_id).

before_id
string<uuid>

Cursor: the notification id the before time belongs to.

organisation_id
string<uuid>

The organisation the caller believes it is reading; a different organisation answers 409.

viewer
string

The user the caller believes it is reading as; a different user answers 409.

Response

One page of the caller's inbox

items
object[]
required
total
integer
required
page
integer
required
page_size
integer
required
total_pages
integer
required
center_view
string