Skip to main content

List Alerts

GET 
/api/alerts

Returns a paginated list of alerts for the authenticated user. Alerts are sorted by creation date descending (newest first).

Authentication: Requires Bearer token

Response fields:

  • id: Alert UUID
  • priority: Alert priority — 'high' or 'normal'
  • category: Alert category — 'orders', 'inventory', 'purchase_orders', 'integrations', 'system', 'financial'
  • title: Alert title
  • message: Alert message body
  • action_url: Optional URL to navigate to from the alert
  • alertable_type: Polymorphic model class name (nullable)
  • alertable_id: Polymorphic model ID (nullable)
  • is_read: Whether the alert has been read
  • read_at: ISO 8601 timestamp of when the alert was read (nullable)
  • created_at: ISO 8601 timestamp of alert creation
  • time_ago: Human-readable relative time (e.g. '5 minutes ago')

Request​

Responses​

Successful response