Get the List of Chat Participants imbot.v2.Chat.User.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
imbotWho can execute the method: owner of the registered bot
The method imbot.v2.Chat.User.list returns the list of chat participants. If the bot is a participant of the chat, it is also in the list — it is identified by the bot: true field.
Users with a deactivated account are not included in the list.
The bot must be a participant of the chat. The method returns the participants of an open chat or an open channel even if the bot is not a participant.
The method does not support pagination: there are no offset parameters, and the response does not contain the total number of participants. A single call returns up to 200 participants. The number of chat participants is available in the userCounter field of the imbot.v2.Chat.get response.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
botId* |
Bot ID |
|
botToken |
Bot token. Required for webhook authorization, not needed for OAuth. Pass the same |
|
dialogId* |
ID of the group chat in the dialogId format: |
|
order |
Sorting. Available fields:
Sort direction: Example: |
|
limit |
Number of records, from |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","order":{"id":"ASC"},"limit":50}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.User.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"dialogId":"chat5","order":{"id":"ASC"},"limit":50,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.User.list
try {
const response = await $b24.callMethod('imbot.v2.Chat.User.list', {
botId: 456,
dialogId: 'chat5',
order: { id: 'ASC' },
limit: 50,
});
const { result } = response.getData();
console.log('result:', result);
} catch (error) {
console.error('Error:', error);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imbot.v2.chat.user.list(
bot_id=456,
dialog_id="chat5",
order={
"id": "ASC",
},
limit=50,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'imbot.v2.Chat.User.list',
[
'botId' => 456,
'dialogId' => 'chat5',
'order' => ['id' => 'ASC'],
'limit' => 50,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'result: ' . print_r($result, true);
} catch (Throwable $exception) {
error_log($exception->getMessage());
echo 'Error: ' . $exception->getMessage();
}
BX24.callMethod(
'imbot.v2.Chat.User.list',
{
botId: 456,
dialogId: 'chat5',
order: { id: 'ASC' },
limit: 50,
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imbot.v2.Chat.User.list',
[
'botId' => 456,
'dialogId' => 'chat5',
'order' => ['id' => 'ASC'],
'limit' => 50,
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
foreach ($result['result'] as $user) {
echo $user['id'] . ': ' . $user['name'] . "\n";
}
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imbot.v2.Chat.User.list", b24.Params{
"botId": 456,
"botToken": "my_bot_token",
"dialogId": "chat5",
"order": b24.Params{
"id": "ASC",
},
"limit": 50,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("imbot.v2.Chat.User.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Active bool `json:"active"`
Name string `json:"name"`
FirstName string `json:"firstName"`
LastName string `json:"lastName"`
WorkPosition string `json:"workPosition"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Active)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"id": 1,
"active": true,
"name": "John Smith",
"firstName": "John",
"lastName": "Smith",
"workPosition": "Developer",
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "15-03",
"extranet": false,
"bot": false,
"connector": false,
"externalAuthId": "default",
"status": "online",
"idle": false,
"lastActivityDate": "2025-01-15T14:25:00+01:00",
"mobileLastDate": false,
"desktopLastDate": "2025-01-15T14:25:00+01:00",
"absent": false,
"departments": [7],
"phones": false,
"type": "user",
"website": "",
"email": ""
},
{
"id": 2,
"active": true,
"name": "Anna Davis",
"firstName": "Anna",
"lastName": "Davis",
"workPosition": "Manager",
"color": "#5b7e91",
"avatar": "",
"gender": "F",
"birthday": "22-08",
"extranet": false,
"bot": false,
"connector": false,
"externalAuthId": "default",
"status": "online",
"idle": false,
"lastActivityDate": "2025-01-15T14:20:00+01:00",
"mobileLastDate": false,
"desktopLastDate": "2025-01-15T14:20:00+01:00",
"absent": false,
"departments": [12],
"phones": false,
"type": "user",
"website": "",
"email": ""
}
],
"time": {
"start": 1728626400.123,
"finish": 1728626400.234,
"duration": 0.111,
"processing": 0.045,
"date_start": "2024-10-11T10:00:00+01:00",
"date_finish": "2024-10-11T10:00:00+01:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Array of chat participants. Description of object fields — User |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "ACCESS_DENIED",
"error_description": "ACCESS_DENIED"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Bot token not specified (botToken is required for webhook auth) |
|
|
|
botId is required |
|
|
|
Bot not found |
Bot not found |
|
|
Bot was installed by another rest application |
The bot is registered by another application |
|
|
CHAT_NOT_FOUND |
No chat found with the specified |
|
|
ACCESS_DENIED |
The bot is not a participant of a private chat |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |