Find Users im.search.user.list

Scope: im

Who can execute the method: any user

The method im.search.user.list allows you to search for users by first name, last name, job title, and department.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
FIND* `string`	Search phrase. The minimum number of characters for the search is `3`
BUSINESS `string`	Search only among business users. Allowed values: `Y` — yes `N` — no Default value is `N`
OFFSET `integer`	Offset for the user selection. Default is `0`
LIMIT `integer`	Number of items in the selection. Default is `10`. Maximum value is `50`

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 '{"FIND":"John","BUSINESS":"N","OFFSET":0,"LIMIT":10}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.search.user.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"FIND":"John","BUSINESS":"N","OFFSET":0,"LIMIT":10,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.search.user.list

try {
          const response = await $b24.callMethod('im.search.user.list', {
            FIND: 'John',
            BUSINESS: 'N',
            OFFSET: 0,
            LIMIT: 10,
          });
        
          const { result, total, next } = response.getData();
          console.log(result, total, next);
        } catch (error) {
          console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.search.user.list',
                [
                    'FIND' => 'John',
                    'BUSINESS' => 'N',
                    'OFFSET' => 0,
                    'LIMIT' => 10,
                ]
            );
        
            $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.search.user.list',
            {
                FIND: 'John',
                BUSINESS: 'N',
                OFFSET: 0,
                LIMIT: 10,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data(), result.total(), result.next());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.search.user.list',
            [
                'FIND' => 'John',
                'BUSINESS' => 'N',
                'OFFSET' => 0,
                'LIMIT' => 10,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            var_dump($result['result']);
        }

Response Handling

HTTP Status Code: 200

{
            "result": [
                {
                    "id": 103,
                    "name": "Emily Smith",
                    "first_name": "Emily",
                    "last_name": "Smith",
                    "work_position": "IT Department Head",
                    "color": "#4ba984",
                    "avatar": "https://example.bitrix24.com/upload/main/avatar.png",
                    "gender": "F",
                    "birthday": "08-03",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "socservices",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2026-03-04T15:40:56+01:00",
                    "mobile_last_date": false,
                    "departments": [1, 7],
                    "absent": false,
                    "phones": {
                        "work_phone": "19123456789",
                        "personal_mobile": "12123456789",
                        "inner_phone": "78"
                    }
                },
                ... // description for each user
            ],
            "total": 2,
            "time": {
                "start": 1772628089,
                "finish": 1772628089.061656,
                "duration": 0.06165599822998047,
                "processing": 0,
                "date_start": "2026-03-04T15:41:29+01:00",
                "date_finish": "2026-03-04T15:41:29+01:00",
                "operating_reset_at": 1772628689,
                "operating": 0
            }
        }

Returned Data

Name `Type`	Description
result `array`	List of found users. The structure of the user object is described in detail below
total `integer`	Total number of found users
next `integer`	Offset for the next page. This field is returned if there is a next page
time `time`	Information about the request execution time

User Object

Name `Type`	Description
id `integer`	User identifier
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
gender `string`	User's gender: `M` or `F`
birthday `string` `boolean`	Birthday in `DD-MM` format or `false`
extranet `boolean`	Indicator of extranet user
network `boolean`	Indicator of Bitrix24 Network user
bot `boolean`	Indicator of bot user
connector `boolean`	Indicator of open channels connector user
external_auth_id `string`	External authorization identifier
status `string`	Current status of the user
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 mobile activity in ISO 8601 (RFC3339) format or `false`
departments `array`	Array of department identifiers
absent `string` `boolean`	Date of absence end in ISO 8601 (RFC3339) format or `false`
phones `object`	User's phones or `false`. The structure of the object is described in detail below

Phones Object

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

Error Handling

HTTP Status: 400

{
            "error": "FIND_SHORT",
            "error_description": "Too short a search phrase."
        }

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
`FIND_SHORT`	Too short a search phrase	The search phrase is not provided or is too short for the internal search filter

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

Find Departments

Add Entry to Search History

Find Users im.search.user.list

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