Get Communications of the humanresources.node.communication.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 the "View Departments" or "View Teams" access permission.
The method humanresources.node.communication.list returns chats, channels, and collabs associated with a department or team.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the department or team. The identifier can be obtained using the humanresources.node.list method. |
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.communication.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/humanresources.node.communication.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/humanresources.node.communication.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CommunicationItem = {
avatar: string | null
color?: string
dialogId: string
hasAccess: boolean
id: number
isExtranet?: boolean
originalNodeId: number | null
subtitle: string
title: string
type: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type NodeCommunicationListResult = {
channels: CommunicationItem[]
channelsNoAccess: number
chats: CommunicationItem[]
chatsNoAccess: number
collabs: CommunicationItem[]
collabsNoAccess: number
}
try {
const response = await $b24.actions.v3.call.make<NodeCommunicationListResult>({
method: 'humanresources.node.communication.list',
params: {
id: 15,
},
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(
'Channels:', result.channels,
'Chats:', result.chats,
'Collabs:', result.collabs
)
}
} 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 fetchNodeCommunications() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'humanresources.node.communication.list',
params: {
id: 15,
},
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(
'Channels:', result.channels,
'Chats:', result.chats,
'Collabs:', result.collabs
)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchNodeCommunications)
</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.communication.list',
[
'id' => 15,
]
);
$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.communication.list',
{
id: 15
},
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.communication.list',
[
'id' => 15,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"channels": [
{
"avatar": "",
"color": "#8474c8",
"dialogId": "chat21",
"hasAccess": true,
"id": 21,
"isExtranet": false,
"originalNodeId": null,
"subtitle": "Private channel",
"title": "Department channel",
"type": "CHANNEL"
}
],
"channelsNoAccess": 0,
"chats": [
{
"avatar": "",
"color": "#1eb4aa",
"dialogId": "chat22",
"hasAccess": true,
"id": 22,
"isExtranet": false,
"originalNodeId": null,
"subtitle": "Private chat",
"title": "Department chat",
"type": "CHAT"
}
],
"chatsNoAccess": 0,
"collabs": [
{
"avatar": null,
"dialogId": "chat23",
"hasAccess": true,
"id": 23,
"originalNodeId": null,
"subtitle": "Collab",
"title": "Department collab",
"type": "COLLAB"
}
],
"collabsNoAccess": 0
},
"time": {
"start": 1780407000,
"finish": 1780407000.104211,
"duration": 0.10421109199523926,
"processing": 0.08111310005187988,
"date_start": "2026-06-02T16:30:00+02:00",
"date_finish": "2026-06-02T16:30:00+02:00",
"operating_reset_at": 1780407600,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
chats[] |
Array of chats associated with the department or team. Description of communication fields |
|
chatsNoAccess |
Number of associated chats not accessible to the current user |
|
channels[] |
Array of channels associated with the department or team. Description of communication fields |
|
channelsNoAccess |
Number of associated channels not accessible to the current user |
|
collabs[] |
Array of collabs associated with the department or team. Description of communication fields |
|
collabsNoAccess |
Number of associated collabs not accessible to the current user |
|
time |
Information about the request execution time |
Communication Fields
|
Name |
Description |
|
avatar |
Link to the communication avatar |
|
color |
Color of the communication. This field is returned for chats and channels |
|
dialogId |
Identifier of the dialog |
|
hasAccess |
Indicator of the current user's access to the communication |
|
id |
Identifier of the communication |
|
isExtranet |
Indicator of extranet communication. This field is returned for chats and channels |
|
originalNodeId |
Identifier of the original department or team |
|
subtitle |
Subtitle of the communication |
|
title |
Title of the communication |
|
type |
Type of communication. Possible values:
|
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error during request object validation",
"validation": [
{
"message": "Required field `id` is missing",
"field": "id"
}
]
}
}
|
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 |
Provide the identifier of the department or team |
Data Not Found Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Object with identifier |
Specify an existing identifier of the department or team |
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Access denied |
Check the access permission to view the department or team |
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 |