get-members-of-a-channel.md

Get Members of a Channel

Lists all channel users.

HTTP Method	URL	Requires Auth
GET	/api/v1/channels.members	yes

Query Parameters

This endpoint supports the #pagination parameters. Additional query parameters are as follows:

{% hint style="info" %} The list of elements a user can use to sort the list is limited. The current sortable element is:username {% endhint %}

Key	Example Value	Description
roomId* or roomName*	ByehQjC44FwMeiLbX or general	The channel ID or the channel name. You must enter at least one of these parameters.
status	['online', 'away']	The user's status (search filter).
filter	my-nickname	Extra search filters to be applied to the fields defined in the Accounts_SearchFields setting.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     https://localhost:3000/api/v1/channels.members?roomId=ByehQjC44FwMeiLbX&count=2

Example Response

{
    "members": [
        {
            "_id": "Loz7qh9ChSqHMPymx",
            "username": "customField_apiuser.test.1529436896005",
            "name": "customField_apiuser.test.1529436896005",
            "status": "offline"
        },
        {
            "_id": "Zc3Y3cRW7ZtS7Y8Hk",
            "username": "customField_apiuser.test.1529436997563",
            "name": "customField_apiuser.test.1529436997563",
            "status": "offline"
        }
    ],
    "count": 2,
    "offset": 0,
    "total": 35,
    "success": true
}

Change Log

Version	Description
0.59.0	Added