Get
/api/v1/livechat/messages/{rid}
View the messages of a specific Livechat room. Permission required: view-l-room
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
Example50
Example25
sort
(object)
List of fields to order by, and in which direction. JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, sort = {"value": -1, "_id": 1}. Refer to the official documentation to learn more.
searchTerm
string
Enter a term that you want to search in the messages.
Responses
200
OK
Example 1
{
"messages": [
{
"_id": "hmnQoYcnSJp7c9f2v",
"rid": "dCBiZX3XPWyPsa6pt",
"ts": "2025-10-16T11:17:07.068Z",
"msg": "",
"groupable": false,
"file": {
"_id": "68f0d43201e202fefed836cf",
"name": "video-designs (1).png",
"type": "image/png",
"size": 17466,
"format": "png"
},
"files": [
{
"_id": "68f0d43201e202fefed836cf",
"name": "video-designs (1).png",
"type": "image/png",
"size": 17466,
"format": "png"
},
{
"_id": "68f0d43301e202fefed836d1",
"name": "thumb-video-designs (1).png",
"type": "image/png",
"size": 14848,
"format": "png"
}
],
"attachments": [
{
"title": "video-designs (1).png",
"title_link": "/file-upload/68f0d43201e202fefed836cf/video-designs%20(1).png",
"title_link_download": true,
"image_dimensions": {
"width": 480,
"height": 301
},
"image_preview": "/9j/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAAUACADASIAAhEBAxEB/8QAGQABAAMBAQAAAAAAAAAAAAAAAAIDBAUI/8QAHRAAAgIDAAMAAAAAAAAAAAAAAQIAAwQRMQUhIv/EABUBAQEAAAAAAAAAAAAAAAAAAAAB/8QAFxEBAQEBAAAAAAAAAAAAAAAAAAERQf/aAAwDAQACEQMRAD8A8qqCzAKNk8EtbGvW4VNUwsPF17kKXNVquvVO5vt8pdZnpklvpRoHUszqXWNca5rjUKmNg6uvcqYFWIYaI6J0a/KXJnvkhvthrepgusNtrO3WOzFzhLUIiJFIiIH/2Q==",
"image_url": "/file-upload/68f0d43301e202fefed836d1/video-designs%20(1).png",
"image_type": "image/png",
"image_size": 17466,
"type": "file",
"description": ""
}
],
"u": {
"_id": "C38WSSzrGd2NCjzqJ",
"username": "test.cat",
"name": "Test Cat"
},
"_updatedAt": "2025-11-12T10:24:44.420Z",
"urls": [],
"mentions": [],
"channels": []
},
{
"_id": "6j9hrchZBHwZHpsF2",
"rid": "dCBiZX3XPWyPsa6pt",
"msg": "hello",
"ts": "2025-10-16T11:16:58.948Z",
"u": {
"_id": "C38WSSzrGd2NCjzqJ",
"username": "test.cat",
"name": "Test Cat"
},
"_updatedAt": "2025-11-12T10:24:44.420Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "hello"
}
]
}
]
},
{
"_id": "CfD55oXeSvvC3jmZS",
"rid": "dCBiZX3XPWyPsa6pt",
"msg": "hello",
"token": "2c9035b72dec31be7e9ccbb3cbd9952394ea41c1517b76c528d403c00a3fccf9",
"alias": "swayyy",
"ts": "2025-10-16T11:16:36.406Z",
"u": {
"_id": "68f0d41001e202fefed836af",
"username": "guest-49",
"name": "swayyy"
},
"_updatedAt": "2025-10-16T11:16:36.447Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "hello"
}
]
}
]
}
],
"offset": 0,
"count": 50,
"total": 3,
"success": true
}object
messages
Array of object
object
_id
string
rid
string
ts
string
msg
string
groupable
boolean
file
object
_id
string
name
string
type
string
size
integer
format
string
files
Array of object
object
_id
string
name
string
type
string
size
integer
format
string
attachments
Array of object
object
title
string
title_link
string
title_link_download
boolean
image_dimensions
object
width
integer
height
integer
image_preview
string
image_url
string
image_type
string
image_size
integer
type
string
description
string
u
object
_id
string
username
string
name
string
_updatedAt
string
urls
Array of object
object
mentions
Array of object
object
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
string
token
string
alias
string
offset
integer
count
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "invalid-room"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string