Get User Data im.user.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: im

Who can execute the method: any user

The method im.user.get retrieves data about the current user or a user by ID.

Method Parameters

Required parameters are marked with *

Name
Type

Description

ID
integer

User identifier. If not provided, the method will return data for the current user.

You can obtain the user identifier using the methods user.get, user.search, or im.chat.user.list

AVATAR_HR
string

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

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":5,"AVATAR_HR":"Y"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.user.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":5,"AVATAR_HR":"Y","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.user.get

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

try {
            $response = $b24Service->core->call(
                'im.user.get',
                [
                    'ID' => 5,
                    'AVATAR_HR' => 'Y',
                ]
            );
        
            $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.get',
            {
                ID: 5,
                AVATAR_HR: 'Y',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

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

Response Handling

HTTP Code: 200

{
            "result": {
                "id": 5,
                "active": true,
                "name": "John Smith",
                "first_name": "John",
                "last_name": "Smith",
                "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": "+11234567890",
                    "personal_mobile": "+11234567890",
                    "inner_phone": "21"
                },
                "website": "example.com",
                "email": "user@example.com",
                "bot_data": null,
                "type": "user"
            },
            "time": {
                "start": 1760000000.0,
                "finish": 1760000000.2,
                "duration": 0.2,
                "processing": 0.08,
                "date_start": "2026-03-02T09:30:00+01:00",
                "date_finish": "2026-03-02T09:30:00+01:00",
                "operating_reset_at": 1760030000,
                "operating": 0
            }
        }

Returned Data

Name
Type

Description

result
object

Object containing user data.

The structure of the object is described in detail below

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 job title
color `string`	User's color in hex format
avatar `string`	Link to the avatar
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`	External user status
network `boolean`	Bitrix24 Network user status
bot `boolean`	Bot status
connector `boolean`	Open Channels user status
external_auth_id `string`	External authorization code
status `string`	User status
idle `datetime`	User's idle date or `false`
last_activity_date `datetime`	User's last activity date
mobile_last_date `datetime`	Last activity date in the mobile app or `false`
desktop_last_date `datetime`	Last activity date in the desktop app or `false`
absent `datetime`	User's absence end date or `false`
departments `array`	Array of department identifiers
phones `object`	User's phones or `false` (detailed description)
bot_data `object`	Bot data or `null`
type `string`	User type
website `string`	User's website
email `string`	User's email

Phones Object

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

Error Handling

HTTP Status: 400

{
            "error": "ID_EMPTY",
            "error_description": "User 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
`ID_EMPTY`	User ID can't be empty	Provided `ID <= 0`
`USER_NOT_EXISTS`	User does not exist	User with the specified `ID` not found
`ACCESS_DENIED`	You can request only users who are part of your extranet group	The current extranet user is requesting a user not from their extranet group

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Continue Learning

Overview of Methods

Retrieve User List Data

Get User Data im.user.get

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