Playground/Resources/Notification
💬

notifications

User notification with title, message, type, priority, read status, action URL, and timestamps. Used for notification systems, alert management, and user engagement platforms.

🎯 Request Builder

https://api.mockly.codes/notifications?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/notifications

Get a collection of notifications

Alternative: /social/notifications
GET/notifications/:id

Get a single notification by ID

Alternative: /social/notifications/:id
GET/notifications/meta

Get resource metadata and schema

Alternative: /social/notifications/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/notifications?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/notifications?q=laptop&search_fields=name,description

💡 Pro Tips

  • Search is case-insensitive and performs partial matching
  • Without search_fields, all text fields are searched
  • Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 notifications
fetch('https://api.mockly.codes/notifications?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/notifications?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/notifications?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/notifications?nocache=true')

Schema Properties

idinteger

Unique identifier for the notification

Gen:random_int
user_idinteger

Foreign key reference to the user who receives this notification

Gen:random_int
titlestring

Notification title or subject

Gen:sentence
messagestring

Notification message or body text

Gen:sentence
typestring

Notification type (e.g., like, comment, follow, mention, system)

Gen:notification_type
prioritystring

Notification priority level (e.g., low, normal, high, urgent)

Gen:priority
readboolean

Whether the notification has been read by the user

Gen:boolean
action_urlstring

URL to navigate to when the notification is clicked

Gen:urluri
created_atstring

Timestamp when the notification was created

Gen:past_datedate-time
read_atstring

Timestamp when the notification was read, null if unread

Gen:past_datedate-time

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request