Notifications

List Notifications

List all notifications for the user's organization.

post/v1/notifications/list

Query parameters

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Request body

notification_type'pipeline_success' | 'pipeline_failure' | 'feature_extraction_success' | 'feature_extraction_failure' | 'system_alert' | 'billing_alert' | 'quota_alert' | 'audit_alert' | 'maintenance_alert' | 'custom' | 'onboarding_nudge' | 'engagement_nudge' | 'feature_tip'

Enum for notification types.

priority'low' | 'medium' | 'high' | 'critical'

Enum for notification priority levels.

readboolean nullable

Filter by read status

user_idstring nullable

Filter by user ID

Response

Successful Response

paginationobject required

Pagination information

totalinteger required

Total number of notifications

Changes

Changed in 2 of the 30 revisions of this API.3

    • the endpoint scheme security BearerAuth was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter after

      new-optional-request-parameter

    • added the new optional query request parameter next_cursor

      new-optional-request-parameter