Views: 3349
Last Modified: 31.08.2018

The method gets multiple users data

Revision: 19
Get information on the current API revision (platform version) – im.revision.get.


Parameter Example Req. Description Revision
ID [4,5] Yes User IDs 19
AVATAR_HR N No Generate avatar in high resolution 19
  • If the ID key is not passed, current user data will be selected.

Method call


BX24.callMethod('im.user.list.get', {ID: [4,5]}, function(result){


$result = restCommand('im.user.list.get', Array(
	'ID' => [4,5],
), $_REQUEST["auth"]);	

Example of response

	"result": {
		4: null,
		5: {
			"id": 5,
			"name": "John Harrington",
			"first_name": "John",
			"last_name": "Harrington",
			"work_position": "",
			"color": "#df532d",
			"avatar": "",
			"gender": "M",
			"birthday": "",
			"extranet": false,
			"network": false,
			"bot": false,
			"connector": false,
			"external_auth_id": "default",
			"status": "online",
			"idle": false,
			"last_activity_date": "2018-01-29T17:35:31+03:00",
			"desktop_last_date": false,
			"mobile_last_date": false,
			"departments": [
			"absent": false,
			"phones": {
			  "work_phone": "",
			  "personal_mobile": "",
			  "personal_phone": ""

Description of keys:

  • id – user ID
  • name – user first and last name
  • first_name – user name
  • last_name – user last name
  • work_position – position
  • color – user color in 'hex' format
  • avatar – link to avatar (if empty, avatar is not specified)
  • avatar_hr – link to avatar in high resolution (available only when a query with parameter AVATAR_HR = 'Y')
  • gender – user gender
  • birthday – user birthday in the DD-MM format, if empty – not specified
  • extranet – extranet user attribute (true/false)
  • network – Bitrix24.Network user attribute (true/false)
  • bot – bot attribute (true/false)
  • connector – Open Channel user attribute (true/false)
  • external_auth_id – external authorization code
  • status – selected user status
  • idle – date, when user is not using his/her PC, in ATOM format (if not specified, false)
  • last_activity_date – date of the last user action, in ATOM format
  • mobile_last_date – date of the last action inside mobile app, in ATOM format (if not specified, false)
  • departments – department IDs
  • desktop_last_date – date of the action in the desktop app, in ATOM format (if not specified, false)
  • absent – date, to which the user has a leave of absence, in ATOM format (if not specified, false)
  • phones – array of phone numbers: work_phone – work phone, personal_mobile – mobile phone, personal_phone – personal phone number

  • Example of response when an error occurs

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

    Description of keys:

    • error – error code
    • error_description – brief description of error

    Possible error codes

    Code Description
    INVALID_FORMAT User ID not passed

    Attention! The method is specified with using of the restCommand function. This method is used to send data in Bitrix24 and is available in the EchoBot example as well as in this article. You can use your own function or BX24.callMethod, or bitrix24-php-sdk JavaScript methods.

Courses developed by Bitrix24