Get a list of users with search by personal data user.search

Scope: user, user_brief, user_basic

Who can execute the method: any user

The user.search method allows you to retrieve a list of users with accelerated search by personal data (first name, last name, middle name, department name, job title). It operates in two modes: quickly using Fulltext Index and a slower option through right LIKE (support is determined automatically).

The list of user fields in Bitrix24 that will be obtained as a result of executing the method depends on the application's/webhook's scope. Details about accessing user data can be found in the article.

The method inherits the behavior of the user.get method, and all parameters from this function are also available.

Method Parameters

Required parameters are marked with *

Name
type

Description

FILTER
string

The array can contain fields in any combination:

  • NAME — first name
  • LAST_NAME — last name
  • WORK_POSITION — job title
  • UF_DEPARTMENT_NAME — department name
  • USER_TYPE — user type. Can take the following values:
    • employee — employee
    • extranet — extranet user
    • email — email user

Or FIND — the field that will search in all listed fields.

The method can work either with filtering using the FIND key or with all other fields. You cannot use FIND and any other field simultaneously.

sort
string

The field by which the results are sorted. Sorting works on all fields from user.add

order
string

Sorting direction:

  • ASC — ascending
  • DESC — descending

ADMIN_MODE
boolean

[Key for operation](*key_Key for operation) in administrator mode. Used to obtain data about any users

start
integer

The parameter is used to manage pagination.

The page size of results is always static: 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the number of the desired page

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "UF_DEPARTMENT": 1,
            "SORT": "ID",
            "ORDER": "asc",
            "start": 10
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.search
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "UF_DEPARTMENT": 1,
            "SORT": "ID",
            "ORDER": "asc",
            "start": 10,
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/user.search
        
try
        {
        	const response = await $b24.callMethod(
        		'user.search',
        		{
        			'UF_DEPARTMENT': 1,
        			'SORT': 'ID',
        			'ORDER': 'asc',
        			'start': 10
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch(error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'user.search',
                    [
                        'UF_DEPARTMENT' => 1,
                        'SORT'         => 'ID',
                        'ORDER'        => 'asc',
                        'start'        => 10,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error searching for users: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "user.search",
            {
                "UF_DEPARTMENT": 1,
                "SORT": "ID",
                "ORDER": "asc",
                "start": 10
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'user.search',
            [
                "UF_DEPARTMENT" => 1,
                "SORT" => 'ID',
                "ORDER" => 'asc',
                "start" => 10
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

    {
                "result": [
                    {
                        "ID": "1",
                        "ACTIVE": true,
                        "NAME": "Vadim",
                        "LAST_NAME": "Valeev",
                        "SECOND_NAME": "",
                        "EMAIL": "v.r.valeev@bitrix.com",
                        "LAST_LOGIN": "2024-07-25T13:06:54+00:00",
                        "DATE_REGISTER": "2024-07-15T00:00:00+00:00",
                        "TIME_ZONE": "",
                        "IS_ONLINE": "Y",
                        "TIMESTAMP_X": {
                        },
                        "LAST_ACTIVITY_DATE": {
                        },
                        "PERSONAL_GENDER": "",
                        "PERSONAL_WWW": "",
                        "PERSONAL_BIRTHDAY": "2018-07-14T00:00:00+00:00",
                        "PERSONAL_MOBILE": "",
                        "PERSONAL_CITY": "",
                        "WORK_PHONE": "",
                        "WORK_POSITION": "",
                        "UF_EMPLOYMENT_DATE": "",
                        "UF_DEPARTMENT": [1],
                        "USER_TYPE": "employee"
                    },
                    {
                        "ID": "3",
                        "ACTIVE": true,
                        "NAME": "Danielle",
                        "LAST_NAME": "Foster",
                        "EMAIL": "test@gmail.com",
                        "LAST_LOGIN": "2024-07-24T09:01:55+00:00",
                        "DATE_REGISTER": "2024-07-22T00:00:00+00:00",
                        "IS_ONLINE": "N",
                        "TIMESTAMP_X": {
                        },
                        "LAST_ACTIVITY_DATE": {
                        },
                        "PERSONAL_GENDER": "",
                        "PERSONAL_BIRTHDAY": "",
                        "WORK_POSITION": "",
                        "UF_EMPLOYMENT_DATE": "",
                        "UF_DEPARTMENT": [1],
                        "USER_TYPE": "employee"
                    }
                ],
                "total": 2,
                "time": {
                    "start": 1721913235.39648,
                    "finish": 1721913235.45078,
                    "duration": 0.05430006980896,
                    "processing": 0.0187909603118897,
                    "date_start": "2024-07-25T13:13:55+00:00",
                    "date_finish": "2024-07-25T13:13:55+00:00",
                    "operating": 0
                }
            }

Returned Data

Name
type

Description

result
object

The root element of the response that contains the filtered list of users

total
integer

The total number of records found

time
time

Information about the execution time of the request

Error Handling

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

USER_NAME LIKE "Text%" - this is called right like, when the search is performed only on text that starts with the specified phrase but can contain different endings - this search is significantly faster than two-way like "%text%" or left-sided "%text" - due to the architecture of storing indexed fields in the database.

Previous
Get User List by Filter
Next
Get User Fields