List Group Members

Prev Next
Get
/api/v1/groups.members

Lists the members of a private group.

Permission required if the room is broadcast.: view-broadcast-member-list

Changelog

Version Description
0.59.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
roomId
string

The room ID. It is required if the roomName is not provided.

Exampledlpfuijw7ej
roomName
string

The room name. It is required if the roomId is not provided.

Examplegeneral
sort

List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}. Refer to the official documentation to learn more.

count
integer

The number of items to return. Refer to the official documentation to learn more.

Example50
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
status
array of string

The user's status (search filter).

Example["online", "away"]
filter
string

Extra search filters to be applied to the fields defined in the Accounts_SearchFields setting.

Responses
200

OK

Success
{
  "members": [
    {
      "_id": "Q4GkX6RMepGDdQ7YJ",
      "status": "online",
      "name": "Marc Pow",
      "utcOffset": -3,
      "username": "marc.pow"
    },
    {
      "_id": "rocket.cat",
      "name": "Rocket.Cat",
      "username": "rocket.cat",
      "status": "online",
      "utcOffset": 0
    }
  ],
  "count": 2,
  "offset": 0,
  "total": 2,
  "success": true
}
Expand All
object
members
Array of object
object
_id
string
status
string
name
string
utcOffset
integer
username
string
count
integer
offset
integer
total
integer
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string