list_notification_events

UsersApi.list_notification_events(role_id=None, limit=None, offset=None, sortorder=None, sortby=None, read=None, from_time=None, to_time=None, projection_expression=None, request_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List notification events

Returns the caller’s in-app notification events. No system-settings check. Also records a user-session audit entry.

Parameters:

  • role_id (str) – Amorphic role ID the request is authorized against. Must be a role the user belongs to. Also recorded in audit logs.

  • limit (str) – Page size as a string. Defaults to 100. Values above 1000 return GE-1028.

  • offset (str) – 1-based item offset as a string. Defaults to 1. Last page when next_available is no. Out of range is 500 (IPV-1026 text, no code prefix).

  • sortorder (str) – Sort direction on CreationTime. Default desc. Only asc reverses the GSI. Any other value sorts descending.

  • sortby (str) – Read but ignored. Sort is always CreationTime on the GSI.

  • read (str) – Filter by Read. Stored values are yes and no. Other values return an empty page.

  • from_time (str) – Inclusive CreationTime start. Applied only when to_time is also set.

  • to_time (str) – Inclusive CreationTime end. Applied only when from_time is also set.

  • projection_expression (str) – Ignored. The handler does not apply a projection.

  • request_type (str) – Ignored. The handler never reads this parameter.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListNotificationEventsResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /notifications/events

Success (HTTP 200)

Page of NotificationEvents with next_available, count, and total_count. next_available is no on the last page.

Request / response example

{
  "NotificationEvents": [
    {
      "NotificationId": "ntf-a2f7d3b1-8e5c-4a6f-9d1e-2b3c4d5e6f7a",
      "UserId": "jane.doe",
      "CreationTime": "2026-08-13 10:15:00",
      "Read": "no",
      "Notification": {
        "Title": "Dataset updated",
        "Message": "sales_data was updated",
        "Type": "Datasets"
      }
    }
  ],
  "next_available": "no",
  "count": 1,
  "total_count": 1
}

Errors

Documented error codes: GE-1028, GE-1008, IPV-1026.

HTTP 400

Validation failure. Body is {“Message”: “<CODE> - <text>”}. Codes: GE-1028 (limit over 1000).

limit over 1000

{
  "Message": "GE-1028 - Out of range for items per page, Limit is 1000"
}

HTTP 500

Uncaught errors return {“Message”: “<str(ex)>”} with no GE-1008 wrap. Invalid offset raises IPV-1026 text without a code prefix. Non-integer limit or offset is a ValueError.

offset past the last item

{
  "Message": "Invalid parameter - OffsetIndex, offset must be between 1 and total_number_of_files(3)"
}

Non-integer limit

{
  "Message": "invalid literal for int() with base 10: 'abc'"
}