Online Users API
Retrieve paginated list of currently online users with filters
Reseller
Online Users API
Retrieve a paginated list of currently online users with optional filtering by server, group, role, and service group.
Online Now
Currently connected.
Filters
Server, group, role.
Real-time
Live user data.
Endpoint Overview
QUERY
/graphqlRetrieve a paginated list of online users with optional filters.
Authentication:Bearer Token
Required scopes:reselleradmin
Request Parameters
pageIntPage number for pagination (0-indexed).
sizeIntNumber of users per page.
serverIdIntFilter by specific server ID.
groupIdIntFilter by specific group ID.
roleIdIntFilter by specific role ID.
serviceGroupIdIntFilter by specific service group ID.
GraphQL Query
query getOnlineUsers($page: Int, $size: Int, $serverId: Int, $groupId: Int, $roleId: Int, $serviceGroupId: Int) {
getOnlineUsers(page: $page, size: $size, serverId: $serverId, groupId: $groupId, roleId: $roleId, serviceGroupId: $serviceGroupId) {
totalElements
size
number
content {
id
email
username
}
}
}Variables:
{
"page": 0,
"size": 20,
"serverId": 1,
"groupId": null,
"roleId": null,
"serviceGroupId": null
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"query": "query getOnlineUsers($page: Int, $size: Int, $serverId: Int) { getOnlineUsers(page: $page, size: $size, serverId: $serverId) { totalElements size number } }",
"variables": { "page": 0, "size": 20, "serverId": 1 }
}'Response
200Online Users Retrieved Successfully
{
"data": {
"getOnlineUsers": {
"totalElements": 120,
"size": 20,
"number": 0
}
}
}Response Fields
totalElementsInt!Total number of online users matching filters.
sizeInt!Number of users per page.
numberInt!Current page number (0-indexed).
content[User!]!Array of online user objects.
Related Endpoints
Real-time Monitoring
Use filters to monitor specific servers, groups, or roles for targeted analysis.
View All Users
Get complete user information.