Get User Data with im.user.list.get
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:
imWho 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 error.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
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 |
Parameter to request the Currently, the |
|
RESULT_TYPE |
Format of the |
Code Examples
How to Use Examples in Documentation
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each user returned in result[] (match the "response handling" section of the page)
type ImUserInfo = {
id: number
active: boolean
name: string
first_name: string
last_name: string
work_position: string
color: string
avatar: string
avatar_hr: string
gender: string
birthday: string
extranet: boolean
network: boolean
bot: boolean
connector: boolean
external_auth_id: string
status: string
idle: ISODate | false
last_activity_date: ISODate
mobile_last_date: ISODate | false
desktop_last_date: ISODate | false
absent: ISODate | false
departments: number[]
phones: { work_phone: string; personal_mobile: string; inner_phone: string } | false
website: string
email: string
bot_data: object | null
type: string
}
try {
const response = await $b24.actions.v2.call.make<ImUserInfo[]>({
method: 'im.user.list.get',
params: {
ID: [4, 5],
AVATAR_HR: 'Y',
RESULT_TYPE: 'array',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Users:', result.length, result.map(u => u.name))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getImUserList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.user.list.get',
params: {
ID: [4, 5],
AVATAR_HR: 'Y',
RESULT_TYPE: 'array',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Users:', result.length, result.map(u => u.name))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getImUserList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.user.list.get(
bitrix_id=[
4,
5,
],
avatar_hr=True,
).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(
'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']);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "im.user.list.get", b24.Params{
"ID": []int{4, 5},
"AVATAR_HR": "Y",
"RESULT_TYPE": "array",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("im.user.list.get: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Active bool `json:"active"`
Name string `json:"name"`
FirstName string `json:"first_name"`
LastName string `json:"last_name"`
WorkPosition string `json:"work_position"`
}
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)
}
Response Handling
HTTP Status: 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 |
Description |
|
User data. By default, an object with identifier keys is returned; when The structure of the user object is described in detail below |
|
|
time |
Information about the request execution time |
User Object
|
Name |
Description |
|
id |
User identifier |
|
active |
User activity status |
|
name |
User's full name |
|
first_name |
User's first name |
|
last_name |
User's last name |
|
work_position |
User's job title |
|
color |
User's color in hex format |
|
avatar |
Link to the avatar |
|
avatar_hr |
Link to the high-resolution avatar |
|
gender |
User's gender |
|
birthday |
Birthday in |
|
extranet |
Extranet user status |
|
network |
Bitrix24 Network user status |
|
bot |
Bot status |
|
connector |
Open Channels user status |
|
external_auth_id |
External authorization code |
|
status |
User status |
|
idle |
User's idle date or |
|
last_activity_date |
User's last activity date |
|
mobile_last_date |
User's last activity date in the mobile app or |
|
desktop_last_date |
User's last activity date in the desktop app or |
|
absent |
User's absence end date or |
|
departments |
Array of department identifiers |
|
phones |
User's phones or |
|
bot_data |
Bot data or |
|
type |
User type |
|
website |
User's website |
|
email |
User's email |
Phones Object
|
Name |
Description |
|
work_phone |
Work phone |
|
personal_mobile |
Mobile phone |
|
inner_phone |
Internal phone |
Error Handling
HTTP Status: 400
{
"error": "INVALID_FORMAT",
"error_description": "A wrong format for the ID field is passed"
}
|
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 |
|
|
A wrong format for the ID field is passed |
The |
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 |