Get a List of Departments humanresources.node.list
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 "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.list returns a list of departments or teams.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
type* |
Type of the structure element. Possible values:
|
|
select |
List of fields for the department or team to return. Available fields:
|
|
pagination |
Pagination parameters:
|
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.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"DEPARTMENT","select":["id","name","type","structureId","parentId","description","accessCode","userCount","colorName","xmlId","createdAt","updatedAt"],"pagination":{"page":1,"limit":20,"offset":0}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/humanresources.node.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"DEPARTMENT","select":["id","name","type","structureId","parentId","description","accessCode","userCount","colorName","xmlId","createdAt","updatedAt"],"pagination":{"page":1,"limit":20,"offset":0},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/humanresources.node.list
// 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
type NodeItem = {
id: number
name: string
type: string
structureId: number
parentId: number | null
description: string
accessCode: string
userCount: number
colorName: string | null
xmlId: string | null
createdAt: ISODate | null
updatedAt: ISODate | null
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type NodeListResult = {
items: NodeItem[]
}
try {
// humanresources.node.list returns a single page (max 200 records). For the whole result set
// use a list helper: $b24.actions.v3.callList.make() returns every record as one
// array, $b24.actions.v3.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 + pagination variant when sort matters.
const response = await $b24.actions.v3.call.make<NodeListResult>({
method: 'humanresources.node.list',
params: {
type: 'DEPARTMENT',
select: [
'id',
'name',
'type',
'structureId',
'parentId',
'description',
'accessCode',
'userCount',
'colorName',
'xmlId',
'createdAt',
'updatedAt',
],
pagination: {
page: 1,
limit: 20,
offset: 0,
},
},
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('Nodes retrieved:', 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 listNodes() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// humanresources.node.list returns a single page (max 200 records). For the whole result set
// use a list helper: $b24.actions.v3.callList.make() returns every record as one
// array, $b24.actions.v3.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 + pagination variant when sort matters.
const response = await $b24.actions.v3.call.make({
method: 'humanresources.node.list',
params: {
type: 'DEPARTMENT',
select: [
'id',
'name',
'type',
'structureId',
'parentId',
'description',
'accessCode',
'userCount',
'colorName',
'xmlId',
'createdAt',
'updatedAt',
],
pagination: {
page: 1,
limit: 20,
offset: 0,
},
},
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('Nodes retrieved:', result.items.length, result.items)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listNodes)
</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.node.list',
[
'type' => 'DEPARTMENT',
'select' => [
'id',
'name',
'type',
'structureId',
'parentId',
'description',
'accessCode',
'userCount',
'colorName',
'xmlId',
'createdAt',
'updatedAt'
],
'pagination' => [
'page' => 1,
'limit' => 20,
'offset' => 0
]
]
);
$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.node.list',
{
type: 'DEPARTMENT',
select: [
'id',
'name',
'type',
'structureId',
'parentId',
'description',
'accessCode',
'userCount',
'colorName',
'xmlId',
'createdAt',
'updatedAt'
],
pagination: {
page: 1,
limit: 20,
offset: 0
}
},
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.list',
[
'type' => 'DEPARTMENT',
'select' => [
'id',
'name',
'type',
'structureId',
'parentId',
'description',
'accessCode',
'userCount',
'colorName',
'xmlId',
'createdAt',
'updatedAt'
],
'pagination' => [
'page' => 1,
'limit' => 20,
'offset' => 0
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"items": [
{
"id": 1,
"name": "Sales Department",
"type": "DEPARTMENT",
"structureId": 1,
"parentId": null,
"description": "Main sales department",
"accessCode": "DR1",
"userCount": 18,
"colorName": null,
"xmlId": null,
"createdAt": "2026-05-20T10:15:00+02:00",
"updatedAt": "2026-06-02T10:30:00+02:00"
},
{
"id": 2,
"name": "Marketing Department",
"type": "DEPARTMENT",
"structureId": 1,
"parentId": 1,
"description": "Department responsible for promoting the company's products",
"accessCode": "DR2",
"userCount": 9,
"colorName": null,
"xmlId": "marketing_department",
"createdAt": "2026-05-22T09:00:00+02:00",
"updatedAt": "2026-06-02T11:45:00+02:00"
}
]
},
"time": {
"start": 1780403500,
"finish": 1780403500.248911,
"duration": 0.24891114234924316,
"processing": 0.21900415420532227,
"date_start": "2026-06-02T15:31:40+02:00",
"date_finish": "2026-06-02T15:31:40+02:00",
"operating_reset_at": 1780404100,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing the response data |
|
items |
Array of department or team objects. The composition of the element fields depends on |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION",
"message": "Cannot recognize pagination parameter `{\"limit\":\"abc\"}`"
}
}
|
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
Pagination Errors
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Cannot recognize pagination parameter |
Provide numeric values. |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Required field |
Provide |
|
|
An invalid value for the structure element type was provided |
Use |
Errors in the select Parameter
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Unknown field |
Provide only fields from the |
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Cannot recognize select expression |
Provide |
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: 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 |