Neuratel API
integer · min: 0integer · min: 1 · max: 1000integer · min: 1 · deprecatedboolean
string · uuid · required
System notifications. Receive alerts about call events, system status, and important updates.
List Notifications
GET
https://api.neuratel.ai
/v1/notifications
List notifications for the current organization.
Returns paginated notifications sorted by created_at descending (newest first).
query Parameters
skipNumber of records to skip for pagination. Defaults to 0.
Default: 0
limitMaximum number of records to return. Defaults to 100. Max 1000.
Default: 100
page(Legacy) Use skip/limit
unread_onlyFilter to unread only
Default: false
notification_typeFilter by notification type
List Notifications › Responses
Successful Response
Paginated notification list response.
Standardized pagination format:
- results: List of notifications
- metadata: Pagination info (skip, limit, total, has_more, count)
- unread_count: Additional notification-specific field
object[] · required
object · required
Pagination metadata in API responses.
unread_countMark Notification Read
PATCH
https://api.neuratel.ai
/v1/notifications/{notification_id}/read
Mark a specific notification as read.
path Parameters
notification_idThe unique identifier of the notification.
Mark Notification Read › Responses
Successful Response
Notification response schema
idnotification_typetitlemessageseverityis_readcreated_at