Skip to content

Notifications — list screen

The in-app notification bell.

Base path
/api-v2/notifications

Endpoints

6 endpoints

Method

Standard Operations

1
  • POST /api-v2/notifications Create a notification.

Additional Operations

5
  • POST /api-v2/notifications/list Show my notifications.
    Details

    Request body

    Search, filters and paging for a list screen. Required.

    NameTypeDescription
    filtersobject
    filters.searchstringExample: hosting
    filters.pageintegerMinimum 1. Example: 1
    filters.limitintegerMinimum 1. Example: 20
  • GET /api-v2/notifications/unread-count Count my unread notifications (the bell badge).
  • POST /api-v2/notifications/{notificationId}/mark-read Mark a notification as read.
  • POST /api-v2/notifications/mark-read-all Mark all my notifications as read.
  • POST /api-v2/notifications/{notificationId}/action-retry Retry the action behind a notification that failed.