Group Online

Lists all online users of a group if the group's id is provided, otherwise it gets all online users of all groups. It supports the Query Parameters only.

URL
Requires Auth
HTTP Method
/api/v1/groups.online
yes
GET
Query Parameters
Argument
Example
Required
Description
query
{"_id":"5HmCfpoB7jp2uibTC"}
Optional
See Query Parameter​
Example Call
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/groups.online
Example Result
{
  "online": [
    {
      "_id": "47cRd58HnWwpqxhaZ",
      "username": "test"
    },
    {
      "_id": "BsxzC22xQ43taWdff",
      "username": "uniqueusername"
    }
  ],
  "success": true
}
Query Example Call
This example shows how to filter using group's id.
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/groups.online?query={"_id": "5HmCfpoB7jp2uibTC"}
Query Example Result
{
  "online": [
    {
      "_id": "47cRd58HnWwpqxhaZ",
      "username": "test"
    }
  ],
  "success": true
}
Change Log
Version
Description
0.52.0
Added

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

Argument	Example	Required	Description
`query`	`{"_id":"5HmCfpoB7jp2uibTC"}`	Optional	See Query Parameter

Version	Description
0.52.0	Added

Groups Endpoints

Get Integrations

Last modified 10mo ago