List Notifications

Name: notfs
Rating: 4.8 (50 reviews)
Author: notfs

GET /api/notifications

Retrieve a paginated list of your notifications. Requires notifications:read scope.

Query Parameters

Param	Type	Default	Description
page	int	1	Page number
limit	int	20	Items per page (1-100)
status	enum	—	scheduled, queued, delivered, failed, cancelled
sort	enum	createdAt	createdAt, scheduledAt, title
order	enum	desc	asc or desc

Example

curl "https://api.notfs.dev/api/notifications?status=delivered&limit=5" \
  -H "X-API-Key: ntfs_your_key"

Response (200)

{
  "data": [
    {
      "id": "clx...",
      "title": "Deploy reminder",
      "body": "Push v2.4.1 to production",
      "iconStyle": "BOLT",
      "sound": "DEFAULT",
      "priority": "HIGH",
      "delay": "5m",
      "status": "DELIVERED",
      "scheduledAt": "2026-02-15T12:05:00.000Z",
      "deliveredAt": "2026-02-15T12:05:01.234Z",
      "createdAt": "2026-02-15T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 5,
    "total": 47,
    "totalPages": 10
  }
}

Other Endpoints

Related notification endpoints

GET/api/notifications/:id

Get a single notification by ID

DELETE/api/notifications/:id

Cancel a scheduled or queued notification

GET/api/notifications/stats/summary

Get aggregate delivery statistics