Get All Subscriptions

Prev Next
Get
/api/v1/subscriptions.get

Note that the unread counter value depends on your settings in the Administration > General section.

Changelog

Version Description
0.60.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
updatedSince
string

Date and time from which to fetch changes. Format: ISO 8601 datetime. Optional seconds, optional milliseconds, optional timezone, always with colon time separators.

Example2017-11-25T15:08:17.248Z
Responses
200

OK

Success Example
{
  "update": [
    {
      "t": "c",
      "ts": "2017-11-25T15:08:17.249Z",
      "name": "general",
      "fname": null,
      "rid": "GENERAL",
      "u": {
        "_id": "EoyAmF4mxx5HxJHJB",
        "username": "rocket.cat",
        "name": "Rocket Cat"
      },
      "open": true,
      "alert": true,
      "unread": 1,
      "userMentions": 1,
      "groupMentions": 0,
      "_updatedAt": "2017-11-25T15:08:17.249Z",
      "_id": "5ALsG3QhpJfdMpyc8"
    }
  ],
  "remove": [],
  "success": true
}
Expand All
object
update
Array of object (Subscription)
object
_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
remove
Array of object
object
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string