API DocsRESTNotification service

ListNotifications

Retrieves notifications using an optional filter.

GET
/api/v1/notifications

Query Parameters

pageSizeinteger

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.

Format: "int64"

pageTokenstring

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.

filterstring

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.

curl -X GET "<API_URL>/api/v1/notifications?pageSize=0&pageToken=string&filter=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "notifications": [
    {
      "notificationId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "organizationId": "string",
      "recipientUserId": "string",
      "isRead": true,
      "fullLink": "string",
      "notificationType": "NOTIFICATION_KIND_UNSPECIFIED",
      "contents": "string",
      "entityId": "string"
    }
  ],
  "nextPageToken": "string"
}

Previous

BatchUpdateNotifications POST

Next

Ping Service_ Ping GET