Get Subscription Room
- Print
- DarkLight
- PDF
Get Subscription Room
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/subscriptions.getOne
Note that the unread counter value depends on your settings at the Administration > General section.
Changelog
| Version | Description |
|---|---|
| 0.63.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The token of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The user ID 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:26Z",
"emails": [
{
"address": "[email protected]",
"verified": false
}
],
"name": "EditedRealNameuser.test.1523623548558",
"username": "editedusernameuser.test.1523623548558",
"avatarETag": "6YbLtc4v9b4conXon"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}object
subscription
object
_id
string
open
boolean
alert
boolean
unread
integer
userMentions
integer
groupMentions
integer
ts
string
rid
string
name
string
t
string
u
object
_id
string
username
string
_updatedAt
string
ls
string
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
Was this article helpful?