Find Departments humanresources.node.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: a user with the "View Departments" or "View Teams" access permission.
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The method humanresources.node.search searches for departments or teams by name.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
type* |
Type of the structure element. Possible values:
|
|
name* |
Search string for part of the department or team name |
|
parentId |
Identifier of the parent department to limit the search. The identifier can be obtained using the humanresources.node.list method |
|
pagination |
Pagination parameter. The method uses |
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.node.search
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"DEPARTMENT","name":"Sales","parentId":1,"pagination":{"limit":20}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/humanresources.node.search
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"DEPARTMENT","name":"Sales","parentId":1,"pagination":{"limit":20},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/humanresources.node.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 the payload returned in result (match the "response handling" section of the page)
type NodeSearchResult = {
items: NodeItem[]
}
type NodeItem = {
id: number
name: string
type: string
structureId: number
parentId: number | null
description: string | null
accessCode: string
userCount: number
colorName: string | null
xmlId: string | null
createdAt: ISODate | null
updatedAt: ISODate | null
}
try {
const response = await $b24.actions.v3.call.make<NodeSearchResult>({
method: 'humanresources.node.search',
params: {
type: 'DEPARTMENT',
name: 'Sales',
parentId: 1,
pagination: {
limit: 20,
},
},
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('Found departments:', result.items.length, 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 searchNodes() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'humanresources.node.search',
params: {
type: 'DEPARTMENT',
name: 'Sales',
parentId: 1,
pagination: {
limit: 20,
},
},
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('Found departments:', result.items.length, result.items)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', searchNodes)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
pagination = {
"limit": 20,
}
try:
bitrix_response = client.humanresources.node.search(
type='DEPARTMENT',
name='Sales',
parent_id=1,
pagination=pagination,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
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.node.search',
[
'type' => 'DEPARTMENT',
'name' => 'Sales',
'parentId' => 1,
'pagination' => [
'limit' => 20,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error searching departments: ' . $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.node.search',
{
type: 'DEPARTMENT',
name: 'Sales',
parentId: 1,
pagination: {
limit: 20
}
},
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.node.search',
[
'type' => 'DEPARTMENT',
'name' => 'Sales',
'parentId' => 1,
'pagination' => [
'limit' => 20
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "humanresources.node.search", b24.Params{
"type": "DEPARTMENT",
"name": "Sales",
"parentId": 1,
"pagination": b24.Params{
"limit": 20,
},
})
if err != nil {
return fmt.Errorf("humanresources.node.search: %w", err)
}
// The method wraps the response in an object with the "items" key.
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
return fmt.Errorf("no items key in the response")
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Type string `json:"type"`
StructureID b24.ID `json:"structureId"`
ParentID b24.ID `json:"parentId"`
Description string `json:"description"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Response Handling
HTTP Status: 200
{
"result": {
"items": [
{
"id": 12,
"name": "B2B Sales",
"type": "DEPARTMENT",
"structureId": 1,
"parentId": 1,
"description": "Working with corporate clients",
"accessCode": "DR12",
"userCount": 9,
"colorName": null,
"xmlId": null,
"createdAt": "2026-05-20T10:15:00+02:00",
"updatedAt": "2026-06-01T16:30:00+02:00"
}
]
},
"time": {
"start": 1780399800,
"finish": 1780399800.314519,
"duration": 0.31451892852783203,
"processing": 0.2811400890350342,
"date_start": "2026-06-02T14:30:00+02:00",
"date_finish": "2026-06-02T14:30:00+02:00",
"operating_reset_at": 1780400400,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing response data |
|
items |
Array of found departments and teams |
|
items[] |
Object of the found department or team |
|
id |
Identifier of the department |
|
name |
Name of the department |
|
type |
Type of the structure element |
|
structureId |
Identifier of the company structure |
|
parentId |
Identifier of the parent department |
|
description |
Description of the department |
|
accessCode |
Access code of the department |
|
userCount |
Number of users in the department |
|
colorName |
Team color, if specified |
|
xmlId |
External identifier of the department |
|
createdAt |
Date and time of department creation |
|
updatedAt |
Date and time of the last update of the department |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating the request object",
"validation": [
{
"message": "Required field `name` is not specified",
"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 |
|
|
Required field |
Add the specified field to the request body |
|
|
Field |
Ensure the value passed is of the correct type |
|
|
An invalid department type value was provided |
Use |
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Access denied |
The user does not have permission to view departments and teams |
Error Code: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Insufficient access rights: required scope is missing |
Check the |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |