/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

language

string

Language query overrides Accept-Language header

timestamp__lte

date-time

Filter by timestamp__lte

timestamp__gte

date-time

Filter by timestamp__gte

alertId

uuid | null

Filter by alertId

alertType

string

Filter by alertType

actorId

string

Filter by actorId

actorType

string

Filter by actorType

actorAccountId

string

Filter by actorAccountId

category

string

enum

Filter by category

Allowed:

userId

string

Filter by userId

read

boolean

Filter by read

status

string

enum

Filter by status

includeV1Notifications

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

pageToken

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.

pageSize

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

Accept-Language

string

Source data set is api/v3.0/languages

Responses

200Notification results

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

500Something went wrong in the server. Please try again.