Get
/api/v1/subscriptions.getOne
Get the notification subscription details for a specific room. Note that the unread counter value depends on your settings at the Manage > Workspace > General section.
Changelog
| Version | Description |
|---|---|
| 8.8.0 | Added the threadDrafts field |
| 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.
ExampleByehQjC44FwMeiLbX
Responses
200
OK
Success Example
{
"result": [
{
"_id": "jRca8kibJx8NkLJxt",
"createdAt": "2018-04-13T12:46:26.517Z",
"emails": [
{
"address": "user.test.1523623548558@rocket.chat",
"verified": false
}
],
"name": "EditedRealNameuser.test.1523623548558",
"username": "editedusernameuser.test.1523623548558",
"avatarETag": "6YbLtc4v9b4conXon"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}object
subscription
object (Subscription)
_id
string
open
boolean
alert
boolean
unread
integer
userMentions
integer
groupMentions
integer
ts
string
rid
string
name
string
fname
string | null
t
string
u
object
_id
string
username
string
name
string
_updatedAt
string
ls
string
E2EKey
string
draft
string
The unfinished message draft for the room.
threadDrafts
object
The unfinished thread reply drafts, keyed by the ID of each thread's main message.
property*
string additionalProperties
success
boolean
400
Bad Request
Invalid Parameter
{
"success": false,
"error": "must have required property 'roomId' [invalid-params]",
"errorType": "invalid-params"
}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