Comment on page

Group List

Lists all of the private groups the calling user has joined. It supports the Pagination parameters.
URL
Requires Auth
HTTP Method
/api/v1/groups.list
yes
GET
Example Call
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/groups.list
Example Result
{
    "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
}
Change Log
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

URL	Requires Auth	HTTP Method
`/api/v1/groups.list`	`yes`	`GET`

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

Last modified 5mo ago