Skip to main content
GET
List your notifications

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
sort
string

Sort notifications by created_at or status, prefixed with - for descending. Defaults to -created_at, so an unsorted request reads newest-first.

Example:

"-created_at"

filter
string

Filter notifications. Filterable fields are id, status, saved, archived, organisation, reason, created_at, and the notification_type.domain, notification_type.entity and notification_type.kind paths. Ownership is imposed from the session and cannot be filtered. Archived notifications are excluded unless archived says otherwise.

Example:

"eq(status,[unread])"

Response

A list of notifications.

JSON API response object

data
A list of notifications · object[]
required
meta
object
required
jsonapi
object
required