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

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: 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 based on personal data (first name, last name, patronymic, department name, job title). It operates in two modes: quickly using Fulltext Index and a slower option through [right LIKE](*key_right LIKE) (support is determined automatically).

The list of Bitrix24 user fields that will be retrieved as a result of the method execution depends on the scope of the application/webhook. Details regarding access to user data can be found in the article.

The method inherits the behavior of the user.get method; 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 — position
  • UF_DEPARTMENT_NAME — department name
  • USER_TYPE — user type. It can take the following values:
    • employee — employee
    • extranet — extranet user
    • email — mail user

Or FIND — a field that will be searched for in all listed fields.

The method can work either with filtering using the FIND key or with all other fields. It is not possible to use FIND and any other field simultaneously.

sort
string

The field by which the results are sorted. Sorting works for 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 retrieve data about any users

start
integer

The parameter is used to manage pagination.

The result page size is always static: 50 records.

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

Formula for calculating the value of the start parameter:

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
        
// 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 object returned in result[]
        type UserItem = {
          ID: string
          ACTIVE: boolean
          NAME: string
          LAST_NAME: string
          SECOND_NAME?: string
          EMAIL: string
          LAST_LOGIN: ISODate | ''
          DATE_REGISTER: ISODate | ''
          IS_ONLINE: string
          PERSONAL_BIRTHDAY?: ISODate | ''
          WORK_POSITION?: string
          UF_DEPARTMENT?: number[]
          USER_TYPE: 'employee' | 'extranet' | 'email'
        }
        
        try {
          // user.search returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<UserItem[]>({
            method: 'user.search',
            params: {
              UF_DEPARTMENT: 1,
              SORT: 'ID',
              ORDER: 'asc',
              start: 10,
            },
            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 found on this page:', result.length, result)
          }
        } 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 searchUsers() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // user.search returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'user.search',
                params: {
                  UF_DEPARTMENT: 1,
                  SORT: 'ID',
                  ORDER: 'asc',
                  start: 10,
                },
                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 found on this page:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', searchUsers)
        </script>
        
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"
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                    return;
                }
        
                console.dir(result.data());
        
                if (result.more())
                {
                    result.next();
                }
            }
        );
        
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": "John",
                        "LAST_NAME": "Smith",
                        "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 response root element, which contains the filtered list of users

total
integer

Total number of records found

time
time

Information about the request execution time

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 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

USER_NAME LIKE "Text%" — this is called a right like, where the search is performed only on text that begins with the specified phrase but may contain different endings. Such a search is significantly faster than a two-sided like "%text%" or a left-side like "%text" due to the architecture of indexed field storage in the database.