Notifications

Overview

The Notifications resource provides fake notification data with types, messages, and read status.

Endpoints

Method	Endpoint	Description
GET	/v1/notifications	List all notifications
GET	/v1/notifications/:id	Get a specific notification

Notification Object

{
  "id": 1,
  "userId": 1,
  "type": "like",
  "actorId": 2,
  "entityId": 15,
  "entityType": "social_post",
  "message": "John Doe liked your post",
  "read": false,
  "createdAt": "2026-01-15T12:00:00.000Z"
}

Field	Type	Description
id	number	Unique identifier
userId	number	ID of the notification recipient
type	string	Notification type (like, comment, follow, mention)
actorId	number	ID of the user who triggered the notification
entityId	number	ID of the related entity
entityType	string	Type of the related entity (social_post, comment)
message	string	Notification message text
read	boolean	Whether the notification has been read
createdAt	string	ISO 8601 timestamp

List Notifications

curl https://api.phantomjson.app/v1/notifications

Query Parameters

Parameter	Type	Default	Description
page	number	1	Page number
limit	number	20	Items per page (max: 100)
sort	string	—	Sort field and direction
fields	string	—	Fields to return
userId	number	—	Filter by user ID
type	string	—	Filter by notification type
read	boolean	—	Filter by read status

Response

{
  "data": [
    {
      "id": 1,
      "userId": 1,
      "type": "like",
      "actorId": 2,
      "entityId": 15,
      "entityType": "social_post",
      "message": "John Doe liked your post",
      "read": false,
      "createdAt": "2026-01-15T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 75,
    "page": 1,
    "limit": 20,
    "totalPages": 4
  }
}

Get Notification by ID

curl https://api.phantomjson.app/v1/notifications/1

Response

{
  "data": {
    "id": 1,
    "userId": 1,
    "type": "like",
    "actorId": 2,
    "entityId": 15,
    "entityType": "social_post",
    "message": "John Doe liked your post",
    "read": false,
    "createdAt": "2026-01-15T12:00:00.000Z"
  }
}

Examples

Filter by User

curl "https://api.phantomjson.app/v1/notifications?userId=1"

Filter by Type

curl "https://api.phantomjson.app/v1/notifications?type=like"

Filter Unread Notifications

curl "https://api.phantomjson.app/v1/notifications?read=false"

Sort by Creation Date

# Newest first
curl "https://api.phantomjson.app/v1/notifications?sort=createdAt:desc"

# Oldest first
curl "https://api.phantomjson.app/v1/notifications?sort=createdAt:asc"

Field Selection

curl "https://api.phantomjson.app/v1/notifications?fields=id,type,message,read"

Combined Query

# Unread like notifications for user 1
curl "https://api.phantomjson.app/v1/notifications?userId=1&type=like&read=false&sort=createdAt:desc"

Relations

• User — Each notification belongs to a user (userId)
• Actor — Each notification may have an actor user (actorId)