Skip to main content
GET
List the caller's notification inbox

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "actions-info": Adds actions { canBeMarkedRead, canBeMarkedUnread, canBeDeleted } per row.
Available options:
actions-info
orderBy
object[]
whereSeverity
string[]

Filter by one or more severities (alert, reminder, info).

Example:
whereBefore
string

Keyset cursor "|", taken from the last row received. Answers the rows strictly older than it, in the default newest-first order. Unlike page/pageSize it does not shift when a notification arrives between two calls.

Maximum string length: 200
Example:

"lobby"

whereUnread

true = unread only, false = read only, omitted = both.

Example:

true

wherePinned

true = pinned only, false = unpinned only, omitted = both.

Example:

true

whereActionRequired

true = only types the caller must act on, false = only types that are not, omitted = both.

Example:

true

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required