Get Group Online Users
- Print
- DarkLight
- PDF
Get Group Online Users
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/groups.online
Lists all online users of a group if the group's id is provided, otherwise it gets all online users of all groups.
Changelog
| Version | Description |
|---|---|
| 0.52.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
query
This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" } }
Responses
200
OK
Success
{
"online": [
{
"_id": "47cRd58HnWwpqxhaZ",
"username": "test"
},
{
"_id": "BsxzC22xQ43taWdff",
"username": "uniqueusername"
}
],
"success": true
}object
online
Array of object
object
_id
string
username
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?