Get the List of Participants im.dialog.users.list

Scope: im

Who can execute the method: a user with access to the chat

The method im.dialog.users.list returns detailed information about the participants in the dialog with pagination support.

Method Parameters

Required parameters are marked with *

Name `type`	Description
DIALOG_ID* `string`	Identifier of the chat in the format: `chatXXX` — chat `sgXXX` — group or project chat `XXX` — identifier of the personal chat user The chat identifier can be obtained using the im.chat.get method. The user identifier can be retrieved using the user.get and user.search methods
SKIP_EXTERNAL `string`	Exclude system users: `Y` — exclude `N` — do not exclude Default: `N`
SKIP_EXTERNAL_EXCEPT_TYPES `string`	A list of types of system users to keep in the selection, separated by commas. For example: `bot, email`
LIMIT `integer`	Number of items per page. Default: `50`. Maximum value: `200`
LAST_ID `integer`	Identifier of the last user from the selection `LIMIT`. Used for sequential loading of the list
OFFSET `integer`	Offset for pagination. Default: `0`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DIALOG_ID":"chat2935","SKIP_EXTERNAL":"Y","LIMIT":20,"OFFSET":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.users.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DIALOG_ID":"chat2935","SKIP_EXTERNAL":"Y","LIMIT":20,"OFFSET":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/im.dialog.users.list

try
        {
            const response = await $b24.callMethod(
                'im.dialog.users.list',
                {
                    DIALOG_ID: 'chat13',
                    SKIP_EXTERNAL: 'Y',
                    LIMIT: 20,
                    start: 0
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.dialog.users.list',
                    [
                        'DIALOG_ID' => 'chat2935',
                        'SKIP_EXTERNAL' => 'Y',
                        'LIMIT' => 20,
                        'OFFSET' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving dialog users list: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.dialog.users.list',
            {
                DIALOG_ID: 'chat2935',
                SKIP_EXTERNAL: 'Y',
                LIMIT: 20,
                OFFSET: 0
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.dialog.users.list',
            [
                'DIALOG_ID' => 'chat2935',
                'SKIP_EXTERNAL' => 'Y',
                'LIMIT' => 20,
                'OFFSET' => 0
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": [
                {
                "id": 1269,
                "active": true,
                "name": "Alexander Smith",
                "first_name": "Alexander",
                "last_name": "Smith",
                "work_position": "Sales Department Head",
                "color": "#58cc47",
                "avatar": "https://cdn-com.bitrix24.com/avatars/alexander-smith.png",
                "avatar_hr": "https://cdn-com.bitrix24.com/avatars/alexander-smith@2x.png",
                "gender": "M",
                "birthday": "",
                "extranet": false,
                "network": false,
                "bot": false,
                "connector": false,
                "external_auth_id": "socservices",
                "status": "online",
                "idle": false,
                "last_activity_date": "2026-03-02T17:45:59+02:00",
                "mobile_last_date": false,
                "desktop_last_date": false,
                "absent": false,
                "departments": [1],
                "phones": {
                    "personal_mobile": "+19165554419"
                },
                "bot_data": null,
                "type": "user",
                "website": "",
                "email": "a.smith@example.com"
                },
                {
                "id": 99,
                "active": true,
                "name": "Catherine Peterson",
                "first_name": "Catherine",
                "last_name": "Peterson",
                "work_position": "Business Analyst",
                "color": "#58cc47",
                "avatar": "https://cdn-com.bitrix24.com/avatars/catherine-peterson.png",
                "avatar_hr": "https://cdn-com.bitrix24.com/avatars/catherine-peterson@2x.png",
                "gender": "F",
                "birthday": "",
                "extranet": false,
                "network": false,
                "bot": false,
                "connector": false,
                "external_auth_id": "socservices",
                "status": "online",
                "idle": false,
                "last_activity_date": "2026-03-02T17:44:31+02:00",
                "mobile_last_date": false,
                "desktop_last_date": false,
                "absent": false,
                "departments": [121],
                "phones": false,
                "bot_data": null,
                "type": "user",
                "website": "",
                "email": "c.peterson@mail.com"
                },
                {
                "id": 1271,
                "active": true,
                "name": "Dmitry Harris",
                "first_name": "Dmitry",
                "last_name": "Harris",
                "work_position": "Senior Developer",
                "color": "#df532d",
                "avatar": "https://cdn-com.bitrix24.com/avatars/dmitry-harris.png",
                "avatar_hr": "https://cdn-com.bitrix24.com/avatars/dmitry-harris@2x.png",
                "gender": "M",
                "birthday": "",
                "extranet": false,
                "network": false,
                "bot": false,
                "connector": false,
                "external_auth_id": "socservices",
                "status": "online",
                "idle": false,
                "last_activity_date": "2026-03-02T17:45:02+02:00",
                "mobile_last_date": false,
                "desktop_last_date": false,
                "absent": false,
                "departments": [1],
                "phones": false,
                "bot_data": null,
                "type": "user",
                "website": "",
                "email": "d.harris@mail.com"
                }
            ],
            "total": 3,
            "time": {
                "start": 1772477165,
                "finish": 1772477165.266759,
                "duration": 0.26675891876220703,
                "processing": 0,
                "date_start": "2026-03-02T17:46:05+02:00",
                "date_finish": "2026-03-02T17:46:05+02:00",
                "operating_reset_at": 1772477765,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	An array of objects with dialog participant data
total `integer`	Total number of participants available to the current user
next `integer`	Offset for the next page of results. Returned if there is a next page
time `time`	Information about the request execution time

Result Object

Name `type`	Description
id `integer`	User identifier
active `boolean`	User activity status
name `string`	User's full name
first_name `string`	User's first name
last_name `string`	User's last name
work_position `string`	User's position. Can be `null`
color `string`	User's color in HEX format
avatar `string`	Link to the avatar. If empty, the avatar is not set
avatar_hr `string`	Link to the high-resolution avatar
gender `string`	User's gender
birthday `string`	Birthday in `DD-MM` format or an empty string
extranet `boolean`	Indicator of an external extranet user
network `boolean`	Indicator of a Bitrix24.Network user
bot `boolean`	Indicator of a bot
connector `boolean`	Indicator of an Open Channels user
external_auth_id `string`	External authorization code
status `string`	User status
idle `datetime`	Date when the user stepped away from the computer. If not set, `false`
last_activity_date `datetime`	Date of the user's last activity
mobile_last_date `datetime`	Date of the last activity in the mobile application. If not set, `false`
desktop_last_date `datetime`	Date of the last activity in the desktop application. If not set, `false`
absent `datetime`	Date of the user's absence. If not set, `false`
departments `array`	List of user department identifiers
phones `object`	Contact user phones. Can be `false`
bot_data `object`	Bot data. For a regular user, it can be `null`
type `string`	User type
website `string`	User's website
email `string`	User's email

Phones Object

Name `type`	Description
work_phone `string`	Work phone
personal_mobile `string`	Mobile phone
personal_phone `string`	Home phone

Error Handling

HTTP Status: 400, 403

{
            "error": "DIALOG_ID_EMPTY",
            "error_description": "Dialog ID can't be empty"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`DIALOG_ID_EMPTY`	Dialog ID can't be empty	The `DIALOG_ID` was not provided or is invalid
`ACCESS_ERROR`	You do not have access to the specified dialog	No access to the specified dialog
`ACCESS_ERROR`	You don't have access to this chat	No access to the specified chat

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get Chat Participant Identifiers

Exclude Participants from Chat

Get the List of Participants im.dialog.users.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Phones ObjectPhones Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning