Get Groups

Get
/api/v1/groups.list

Lists all the private groups/channels the user has joined.

Changelog

Version Description
0.67.0 Removed query parameter support.
0.62.0 Add query parameter support.
0.49.0 Count and offset query parameters supported.
0.33.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
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
count
integer

The number of items to return. Refer to the official documentation to learn more.

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

Success
{
  "groups": [
    {
      "_id": "ByehQjC44FwMeiLbX",
      "name": "test-test",
      "t": "p",
      "msgs": 0,
      "u": {
        "_id": "aobEdbYhXfu5hkeqG",
        "username": "testing1"
      },
      "ts": "2016-12-09T15:08:58.042Z",
      "ro": false,
      "sysMes": true,
      "_updatedAt": "2016-12-09T15:22:40.656Z"
    },
    {
      "_id": "t7qapfhZjANMRAi5w",
      "name": "testing",
      "t": "p",
      "msgs": 0,
      "u": {
        "_id": "y65tAmHs93aDChMWu",
        "username": "testing2"
      },
      "ts": "2016-12-01T15:08:58.042Z",
      "ro": false,
      "sysMes": true,
      "_updatedAt": "2016-12-09T15:22:40.656Z"
    }
  ],
  "offset": 0,
  "count": 1,
  "total": 1,
  "success": true
}
Expand All
object
groups
Array of object
object
_id
string
name
string
t
string
msgs
integer
u
object
_id
string
username
string
ts
string
ro
boolean
sysMes
boolean
_updatedAt
string
offset
integer
count
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