Notifications API

REST API endpoints for Notifications.

REST API endpoints for Notifications. 10 operations.

List notifications

GET /v1/notifications

Requires the notifications:read scope.

Auth: Bearer API key

Responses

operationId: listNotifications

Send a notification

POST /v1/notifications

Requires the notifications:write scope.

Auth: Bearer API key

Responses

operationId: sendNotification

Get a notification

GET /v1/notifications/{id}

Requires the notifications:read scope.

Auth: Bearer API key

Responses

operationId: getNotification

Mark a notification read

POST /v1/notifications/{id}/read

Requires the notifications:write scope.

Auth: Bearer API key

Responses

operationId: markNotificationRead

Register a notification device

POST /v1/notifications/devices

Requires the notifications:write scope.

Auth: Bearer API key

Responses

operationId: registerNotificationDevice

Unregister a notification device

DELETE /v1/notifications/devices/{device_id}

Requires the notifications:write scope.

Auth: Bearer API key

Responses

operationId: unregisterNotificationDevice

Get notification preferences

GET /v1/notifications/preferences

Requires the notifications:read scope.

Auth: Bearer API key

Responses

operationId: getNotificationPreferences

Update notification preferences

PUT /v1/notifications/preferences

Requires the notifications:write scope.

Auth: Bearer API key

Responses

operationId: updateNotificationPreferences

Mark all notifications read

POST /v1/notifications/read-all

Requires the notifications:write scope.

Auth: Bearer API key

Responses

operationId: markAllNotificationsRead

Unread notification count

GET /v1/notifications/unread-count

Requires the notifications:read scope.

Auth: Bearer API key

Responses

operationId: getUnreadCount