Skip to main content
GET
/
api
/
v1
/
notifications
ListNotifications
curl --request GET \
  --url https://your-sift-api-url.com/api/v1/notifications \
  --header 'Authorization: Bearer <token>'
{
  "notifications": [
    {
      "notificationId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "modifiedByUserId": "<string>",
      "organizationId": "<string>",
      "recipientUserId": "<string>",
      "isRead": true,
      "fullLink": "<string>",
      "notificationType": "NOTIFICATION_KIND_UNSPECIFIED",
      "contents": "<string>",
      "entityId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageSize
integer<int64>

The maximum number of notifications to return. The service may return fewer than this value. If unspecified, at most 50 notifications will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListNotifications call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListNotifications must match the call that provided the page token.

​
filter
string

A Common Expression Language (CEL) filter string. Available fields to filter by are notification_id, created_by_user_id, recipient_user_id, created_date, notification_type, and is_read. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

Response

A successful response.

The response of a call to NotificationService_ListNotifications.

​
notifications
object[]
​
nextPageToken
string