Find Employess humanresourses.employee.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:
humanresourcesWho can execute the method: an authorized user linked to a department in the company structure.
The method humanresources.employee.search searches for employees by name.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
name* |
Search string for the employee's name |
|
nodeId |
Identifier of the department or team to limit the search. The identifier can be obtained using the humanresources.node.list method. |
|
select |
List of employee fields to return. Available fields:
|
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/humanresources.employee.search
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"John","select":["userId","name","workPosition","avatar","url","departments","teams"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/humanresources.employee.search
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"John","select":["userId","name","workPosition","avatar","url","departments","teams"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/humanresources.employee.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type EmployeeSearchResult = {
items: {
userId: number
name: string
workPosition: string
avatar: string
url: string
departments: { id: number; name: string }[]
teams: { id: number; name: string }[]
}[]
}
try {
const response = await $b24.actions.v3.call.make<EmployeeSearchResult>({
method: 'humanresources.employee.search',
params: {
name: 'Ivan',
select: [
'userId',
'name',
'workPosition',
'avatar',
'url',
'departments',
'teams',
],
},
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(result.items)
}
} 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 searchEmployees() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'humanresources.employee.search',
params: {
name: 'Ivan',
select: [
'userId',
'name',
'workPosition',
'avatar',
'url',
'departments',
'teams',
],
},
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(result.items)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', searchEmployees)
</script>
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'humanresources.employee.search',
[
'name' => 'John',
'select' => [
'userId',
'name',
'workPosition',
'avatar',
'url',
'departments',
'teams',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'humanresources.employee.search',
{
name: 'John',
select: [
'userId',
'name',
'workPosition',
'avatar',
'url',
'departments',
'teams'
]
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'humanresources.employee.search',
[
'name' => 'John',
'select' => [
'userId',
'name',
'workPosition',
'avatar',
'url',
'departments',
'teams',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"items": [
{
"userId": 7,
"name": "John Smith",
"workPosition": "Sales Manager",
"avatar": "https://example.bitrix24.com/upload/main/avatar.jpg",
"url": "/company/personal/user/7/",
"departments": [
{
"id": 15,
"name": "Sales Department"
}
],
"teams": []
}
]
},
"time": {
"start": 1780407400,
"finish": 1780407400.143201,
"duration": 0.14320111274719238,
"processing": 0.11092114448547363,
"date_start": "2026-06-02T16:36:40+02:00",
"date_finish": "2026-06-02T16:36:40+02:00",
"operating_reset_at": 1780408000,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
items |
Array of found employees. The structure of the element fields depends on |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error during request object validation",
"validation": [
{
"message": "Parameter \"name\" is required.",
"field": "name"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Parameter |
Provide a search string |
Errors in the select Parameter
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Unknown field |
Provide only employee fields from the list |
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Unable to recognize select expression |
Provide |
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Access denied |
Ensure that the current user is an employee of Bitrix24 |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |