API Reference
Getting startedVisit een.comMy Application/Login

/notifications

get
https://{BaseUrl}/api/v3.0/notifications

Search and sort notifications by alertId, alertType, actorId, actorType, actorAccountId, category, and read. V1 notifications can be requested with includeV1Notifications.

Query Params
string

Language query overrides Accept-Language header

date-time

Filter by timestamp__lte

date-time

Filter by timestamp__gte

uuid | null

Filter by alertId

string

Filter by alertType

string

Filter by actorId

string

Filter by actorType

string

Filter by actorAccountId

string
enum

Filter by category

Allowed:
string

Filter by userId

boolean

Filter by read

string
enum

Filter by status

boolean

When set to true, includes v1 notifications in the response along with current notifications.

sort
array of strings
Defaults to -timestamp

Sort by timestamp

sort
string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

integer
1 to 1000
Defaults to 100

The number of entries to return per page for cassandra. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Headers
string

Source data set is api/v3.0/languages

Responses

Updated 5 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago