---
title: "List Online Users in a Channel"
slug: "list-online-users-in-a-channel"
updated: 2026-06-08T12:46:40Z
published: 2026-06-08T12:46:40Z
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# List Online Users in a Channel

Get/api/v1/channels.online

List all online users in a particular channel.

### Changelog

| Version | Description |
| --- | --- |
| 0.52.0 | Added |
| 7.0.0 | Replaced `query` parameter with `_id` parameter |

Header parametersX-Auth-TokenstringRequired

The `authToken` of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-IdstringRequired

The `userId` of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Query parameters_idstringRequired

The channel's id.

Example5HmCfpoB7jp2uibTC

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='ce67ef3e-6d86-417a-b900-9c27aaf62c17'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='f3a75a2e-cd04-462c-956c-9beaf7140a53'>Example</option>
</select>Example

```json
{
  "online": [
    {
      "_id": "47cRd58HnWwpqxhaZ",
      "username": "test"
    },
    {
      "_id": "BsxzC22xQ43taWdff",
      "username": "uniqueusername"
    }
  ],
  "success": true
}
```

Expand Allobject  online Array of object   object  _idstring    
usernamestring    

successboolean    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='c41803f3-5fef-4d90-bdc0-38ac7c5a23f8'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='b0c4808b-ee79-4375-89d6-c623f68b6c52'>Authorization Error</option>
</select>Authorization Error

```json
{
  "status": "error",
  "message": "You must be logged in to do this."
}
```

object  statusstring    
messagestring