Notifications

LIVE

User notifications with type and read flags.

Endpoints

GETPOSTList or create
/api/notifications
GETPATCHDELETERead, update, or delete one
/api/notifications/:id
GETUnread only
/api/notifications?read=false
GETFilter by user
/api/notifications?userId=

Query params

Param	Description	Example
search	Title or message	search=welcome
userId	Filter by user UUID	userId=…
type	info · success · warning · error	type=warning
read	true · false	read=false
sort	createdAt · title	sort=title
page	Page number · default 1	page=2
limit	Page size · default 12 · max 50	limit=12
order	asc · desc	order=asc
lang	Pass fa for Persian text · omit for English (default)	lang=fa
delay	Artificial wait in ms · max 5000	delay=800
status	Force error HTTP status · 400–599	status=500

Persian text: add lang=fa. See Docs · Language.

Try:/api/notifications?read=false&limit=6

Request

1const { data } = await axios.get('/api/notifications', { params: { read: false } });

Response

1{2  "data": [3    {4      "id": "c9d0e1f2-a3b4-5678-c345-789012345678",5      "userId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",6      "title": "Welcome to MockData",7      "message": "Your workspace seed data is ready to explore.",8      "type": "success",9      "read": false,10      "createdAt": "2026-09-14T10:00:00.000Z",11      "updatedAt": "2026-09-14T10:00:00.000Z"12    }13  ],14  "pagination": {15    "page": 1,16    "limit": 12,17    "total": 24,18    "totalPages": 219  }20}