Skip to content
OriginChats

users_list

Fetch the full member list. Clients usually call it once after connecting to fill the member sidebar, then keep it current from presence events.

Request

Section titled “Request”
{
  "cmd": "users_list"
}

No fields besides cmd.

Response

Section titled “Response”
{
  "cmd": "users_list",
  "users": [
    {
      "username": "alice",
      "nickname": "Alice W.",
      "roles": ["admin", "user"],
      "color": "#FF0000",
      "cracked": false,
      "clients": ["originchats"],
      "devices": ["computer"],
      "status": { "status": "online", "text": "" }
    },
    {
      "username": "bob",
      "roles": ["user"],
      "color": null,
      "cracked": false,
      "clients": [],
      "devices": [],
      "status": { "status": "offline", "text": "" }
    }
  ]
}

Each entry is a user object with a status added. The list includes every current member, connected or not. It leaves out users who have left or are banned.

The list is built for you, so don’t pass it on to other viewers:

  • A disconnected user has empty clients and devices and an offline status.
  • A user who set invisible or offline looks disconnected to ordinary members. You see their real status and sessions if you are that user or have manage_users.

The server also sends a users_list frame on its own when a connection signs in as a different account.

Permissions

Section titled “Permissions”

Any member can call it.

Errors

Section titled “Errors”

This command has no command-specific errors.

See also

Section titled “See also”