Get
/api/v1/chat.getPinnedMessages
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
roomId
stringRequired
The room ID.
Example6GFJ3tbmHiyHbahmC
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
Example50
sort
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, { "value": -1, "_id": 1 }. Refer to the official documentation to learn more.
Responses
200
OK
Example 1
{
"messages": [
{
"_id": "ycHhPqyoN2BZHt3Ag",
"rid": "6GFJ3tbmHiyHbahmC",
"msg": "ekaara",
"ts": "2023-02-25T16:08:30.000Z",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"_updatedAt": "2023-10-16T23:30:58.917Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "ekaara"
}
]
}
],
"pinned": true,
"pinnedAt": "2023-10-16T23:30:58.917Z",
"pinnedBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie"
}
},
{
"_id": "Ay9jYg48gzjfpy7pk",
"rid": "6GFJ3tbmHiyHbahmC",
"msg": "wassup",
"ts": "2023-10-05T19:10:10.055Z",
"u": {
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.john",
"name": "Testtest"
},
"_updatedAt": "2023-10-16T23:30:42.393Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "wassup"
}
]
}
],
"pinned": true,
"pinnedAt": "2023-10-16T23:30:42.393Z",
"pinnedBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie"
}
},
{
"_id": "NZieMNQDEdMDmLLip",
"rid": "6GFJ3tbmHiyHbahmC",
"msg": "hola",
"ts": "2023-10-05T20:30:51.052Z",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"_updatedAt": "2023-10-16T22:57:27.362Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "hola"
}
]
}
],
"reactions": {
":smile:": {
"usernames": [
"test.test"
]
}
},
"starred": [],
"pinned": true,
"pinnedAt": "2023-10-05T20:59:44.433Z",
"pinnedBy": {
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.test"
},
"replies": [
"rbAXPnMktTFbNpwtJ"
],
"tcount": 2,
"tlm": "2023-10-16T22:57:27.158Z"
}
],
"count": 3,
"offset": 0,
"total": 3,
"success": true
}object
messages
Array of object
object
_id
string
rid
string
msg
string
ts
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
pinned
boolean
pinnedAt
string
pinnedBy
object
_id
string
username
string
reactions
object
:smile:
object
usernames
Array of string
string
starred
Array of object
object
replies
Array of string
string
tcount
integer
tlm
string
count
integer
offset
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"roomId\" query param is missing. [error-roomId-param-not-provided]",
"errorType": "error-roomId-param-not-provided"
}Incorrect room ID
{
"success": false,
"error": "Not allowed [error-not-allowed]",
"errorType": "error-not-allowed"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string