Get all user mentions in a channel
- Print
- DarkLight
- PDF
Get all user mentions in a channel
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/channels.getAllUserMentionsByChannel
Get all the mentions of the authenticated user in a channel.
Changelog
| Version | Description |
|---|---|
| 0.63.0 | Added |
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.
Examplejdiue8TGkodp
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
count
integer
The number of items to return.
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}
Responses
200
OK
Success
{
"mentions": [
{
"_id": "mPmJ6cPAazzphJmGe",
"rid": "6513afeda2f73c7460e18c86",
"msg": "@roxie",
"ts": "2023-09-27T20:32:58.994Z",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"_updatedAt": "2023-09-27T20:32:59.171Z",
"urls": [],
"mentions": [
{
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test",
"type": "user"
}
],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "MENTION_USER",
"value": {
"type": "PLAIN_TEXT",
"value": "roxie"
}
}
]
}
]
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}object
mentions
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
_id
string
username
string
name
string
type
string
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
object
type
string
value
string
count
integer
offset
integer
total
integer
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?