users_online

Fetch the members who have at least one open, signed-in connection. Use users_list when you need everyone, including offline members.

Request

{
  "cmd": "users_online"
}

No fields besides cmd.

Response

{
  "cmd": "users_online",
  "users": [
    {
      "username": "alice",
      "roles": ["admin", "user"],
      "color": "#FF0000",
      "cracked": false,
      "clients": ["originchats", "originchats-cli"],
      "devices": ["computer", "mobile"],
      "status": { "status": "dnd", "text": "focusing" }
    }
  ]
}

Each entry is a user object with a status added. clients and devices list the user’s current sessions, sorted.

Users whose status is invisible or offline are left out, unless you are that user or have manage_users.
A user missing from this list may still be a member. Don’t remove anyone from your member list because of it.

Permissions

Any member can call it.

Errors

This command has no command-specific errors.

See also