Get User Data with im.user.list.get

Scope: im

Who can execute the method: any user

The method im.user.list.get returns data about users based on a list of identifiers.

If the current user is an extranet user, the method will return data only for users from their extranet groups. User identifiers outside these groups will be skipped without an error.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
ID* `array` `string`	An array of user identifiers or a JSON string containing an array. User identifiers can be obtained using the methods user.get, user.search, or im.chat.user.list
AVATAR_HR `string`	A parameter to request the `avatar_hr` field with the high-resolution avatar URL. Acceptable values: `Y` or `N`, default is `N`. Currently, the `avatar_hr` field is always returned, regardless of the parameter value
RESULT_TYPE `string`	Format of the `result`. The value `array` will return a standard array of user objects, while any other value will return an object with user identifier keys

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 '{"ID":[4,5],"AVATAR_HR":"Y","RESULT_TYPE":"array"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.user.list.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":[4,5],"RESULT_TYPE":"array","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.user.list.get

try {
          const response = await $b24.callMethod('im.user.list.get', {
            ID: [4, 5],
            AVATAR_HR: 'Y',
            RESULT_TYPE: 'array',
          });
        
          const { result } = response.getData();
          console.log(result);
        } catch (error) {
          console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.user.list.get',
                [
                    'ID' => [4, 5],
                    'AVATAR_HR' => 'Y',
                    'RESULT_TYPE' => 'array',
                ]
            );
        
            $result = $response->getResponseData()->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                var_dump($result->data());
            }
        } catch (Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'im.user.list.get',
            {
                ID: [4, 5],
                AVATAR_HR: 'Y',
                RESULT_TYPE: 'array',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.user.list.get',
            [
                'ID' => [4, 5],
                'AVATAR_HR' => 'Y',
                'RESULT_TYPE' => 'array',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            var_dump($result['result']);
        }

Response Handling

HTTP Code: 200

{
            "result": [
                {
                    "id": 4,
                    "active": true,
                    "name": "Emily Smith",
                    "first_name": "Emily",
                    "last_name": "Smith",
                    "work_position": "Analyst",
                    "color": "#df532d",
                    "avatar": "https://example.bitrix24.com/upload/main/avatar4.png",
                    "avatar_hr": "https://example.bitrix24.com/upload/main/avatar4_hr.png",
                    "gender": "F",
                    "birthday": "",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "default",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2026-03-02T09:30:00+01:00",
                    "mobile_last_date": false,
                    "desktop_last_date": false,
                    "absent": false,
                    "departments": [7, 5],
                    "phones": {
                        "work_phone": "+12123456789",
                        "personal_mobile": "+12123456789",
                        "inner_phone": "22"
                    },
                    "website": "example.com",
                    "email": "emily.smith@example.com",
                    "bot_data": null,
                    "type": "user"
                },
                {
                    "id": 5,
                    "active": true,
                    "name": "John Johnson",
                    "first_name": "John",
                    "last_name": "Johnson",
                    "work_position": "Manager",
                    "color": "#048bd0",
                    "avatar": "https://example.bitrix24.com/upload/main/avatar.png",
                    "avatar_hr": "https://example.bitrix24.com/upload/main/avatar_hr.png",
                    "gender": "M",
                    "birthday": "",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "default",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2026-03-02T09:30:00+01:00",
                    "mobile_last_date": false,
                    "desktop_last_date": false,
                    "absent": false,
                    "departments": [10],
                    "phones": {
                        "work_phone": "+12123456788",
                        "personal_mobile": "+12123456788",
                        "inner_phone": "21"
                    },
                    "website": "example.com",
                    "email": "user@example.com",
                    "bot_data": null,
                    "type": "user"
                }
            ],
            "time": {
                "start": 1772449081,
                "finish": 1772449081.887056,
                "duration": 0.8870561122894287,
                "processing": 0,
                "date_start": "2026-03-02T13:58:01+01:00",
                "date_finish": "2026-03-02T13:58:01+01:00",
                "operating_reset_at": 1772449681,
                "operating": 0
            }
        }

Returned Data

Name
Type

Description

result
object
array

User data. By default, an object with identifier keys is returned; when RESULT_TYPE = 'array', an array is returned.

The structure of the user object is described in detail below

time
time

Information about the request execution time

User Object

Name `Type`	Description
id `integer`	User identifier
active `boolean`	User account 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 job title
color `string`	User's color in HEX format
avatar `string` `null`	Link to the user's avatar
avatar_hr `string` `null`	Link to the high-resolution avatar. Currently, this field always returns a value, regardless of the `AVATAR_HR` setting
gender `string`	User's gender: `M`, `F`, or empty if not specified
birthday `string`	Birthday in `DD-MM` format or an empty string
extranet `boolean`	Extranet user status
network `boolean`	Bitrix24 Network user status
bot `boolean`	Bot user status
connector `boolean`	Open Channels connector user status
external_auth_id `string`	External authentication identifier
status `string`	User status. In the new messenger, this field always contains `online` regardless of the actual status set. The current status can be checked using the im.user.status.get method, and changed using the im.user.status.set method
idle `string` `boolean`	Time of transition to "Away" status in ISO 8601 (RFC3339) format or `false`
last_activity_date `string` `boolean`	Time of last activity in ISO 8601 (RFC3339) format or `false`
mobile_last_date `string` `boolean`	Time of last activity in the mobile application in ISO 8601 (RFC3339) format or `false`
desktop_last_date `string` `boolean`	Time of last activity in the desktop application in ISO 8601 (RFC3339) format or `false`
absent `string` `boolean`	Date of absence end in ISO 8601 (RFC3339) format or `false`
departments `array`	Array of department identifiers
phones `object` `boolean`	User's phones or `false`. The structure of the object is described in detail below
website `string`	User's website or an empty string
email `string`	User's email or an empty string
bot_data `object` `null`	Bot data for bot users
type `string`	User type

Phones Object

Name `Type`	Description
personal_mobile `string`	Mobile phone
work_phone `string`	Work phone
inner_phone `string`	Internal phone

Error Handling

HTTP Status: 400

{
            "error": "INVALID_FORMAT",
            "error_description": "A wrong format for the ID field is passed"
        }

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
`INVALID_FORMAT`	A wrong format for the ID field is passed	The `ID` parameter is not provided or is in an incorrect format

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

Retrieve User Data

Set User Status

Get User Data with im.user.list.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

User ObjectUser Object

Phones ObjectPhones Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning