💬

messages

Direct message or private message between users with sender/receiver information, content, message type, read status, and timestamps. Used for messaging systems, chat applications, and private communication platforms.

🎯 Request Builder

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

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

Endpoints

GET/messages

Get a collection of messages

Alternative: /social/messages
GET/messages/:id

Get a single message by ID

Alternative: /social/messages/:id
GET/messages/meta

Get resource metadata and schema

Alternative: /social/messages/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/messages?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/messages?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 messages
fetch('https://api.mockly.codes/messages?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the message

Gen:random_int
conversation_idinteger

Foreign key reference to the conversation this message belongs to

Gen:random_int
sender_idinteger

Foreign key reference to the user who sent the message

Gen:random_int
sender_namestring

Full name of the message sender

Gen:name
receiver_idinteger

Foreign key reference to the user who receives the message

Gen:random_int
receiver_namestring

Full name of the message receiver

Gen:name
contentstring

Message text content

Gen:sentence
typestring

Message type (e.g., text, image, file, system)

Gen:message_type
readboolean

Whether the message has been read by the receiver

Gen:boolean
created_atstring

Timestamp when the message was sent

Gen:past_datedate-time
read_atstring

Timestamp when the message 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