List app notifications

Returns a list of dashboard (in-app) notifications. When authenticated as a user, only that user's notifications are returned; when authenticated with an API key, notifications across the whole organization are returned. The X-Total-Count response header carries the total number of matching notifications.

Query Params
integer
Defaults to 1

The page number to retrieve.

integer
Defaults to 20

The number of items to retrieve per page.

boolean

Filter by whether the notification has been read.

source_entity_type
array of strings, unique

An optional comma-separated list of source entity types to filter by, e.g. ?source_entity_type=claim,policy.

include
array of strings, unique

An optional comma-separated list of underlying objects to include, e.g. ?include=source_entity,created_by_profile.

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json