For AI agents: markdown of this page — /docs-content-en/humanresources/node-operations/communications-get.md documentation index — /llms.txt

Node communication tools

GET /v1/humanresources/nodes/:id/communications

Returns the communication tools linked to an organizational structure node: chats, channels, and collabs.

The generic filter parameter is not applied by this endpoint. By default, the API preserves the previous HTTP 200 response and data, adds Warning: 299 - "filter is not supported on this endpoint and was ignored", and records unsupported-filter use in the server log.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionNode identifier. List: GET /v1/humanresources/nodes?type=DEPARTMENT

Examples

curl — personal key

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.com/v1/humanresources/nodes/23/communications

curl — OAuth application

Terminal 
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.com/v1/humanresources/nodes/23/communications

JavaScript — personal key

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.com/v1/humanresources/nodes/23/communications',
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)
const body = await res.json()
console.log(body.data.chats)

JavaScript — OAuth application

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.com/v1/humanresources/nodes/23/communications',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
const body = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.chats Typearray DescriptionChats linked to the node
Fielddata.channels Typearray DescriptionChannels linked to the node (element structure matches chats)
Fielddata.collabs Typearray DescriptionCollabs linked to the node (element structure matches chats)
Fielddata.chats[].id Typenumber DescriptionCommunication tool identifier
Fielddata.chats[].dialogId Typestring DescriptionDialog identifier of the tool
Fielddata.chats[].title Typestring DescriptionTitle
Fielddata.chats[].subtitle Typestring DescriptionSubtitle
Fielddata.chats[].avatar Typestring DescriptionImage URL. Empty string if no image is set
Fielddata.chats[].color Typestring DescriptionColor in HEX format
Fielddata.chats[].type Typestring DescriptionTool type: CHAT, CHANNEL, or COLLAB
Fielddata.chats[].isExtranet Typeboolean DescriptionFlag for a tool from the extranet
Fielddata.chats[].originalNodeId Typenumber | null DescriptionNode the link is inherited from. null if the link is set directly
Fielddata.chats[].hasAccess Typeboolean DescriptionWhether the current user has access to the tool
Fielddata.chatsNoAccess Typenumber DescriptionNumber of linked chats the current user has no access to
Fielddata.channelsNoAccess Typenumber DescriptionNumber of linked channels the current user has no access to
Fielddata.collabsNoAccess Typenumber DescriptionNumber of linked collabs the current user has no access to

Response example

JSON 
{
  "success": true,
  "data": {
    "chats": [
      {
        "id": 3645,
        "dialogId": "chat3645",
        "title": "Sales department",
        "subtitle": "Private chat",
        "avatar": "",
        "color": "#f76187",
        "type": "CHAT",
        "isExtranet": false,
        "originalNodeId": null,
        "hasAccess": true
      }
    ],
    "channels": [],
    "collabs": [],
    "chatsNoAccess": 0,
    "channelsNoAccess": 0,
    "collabsNoAccess": 0
  }
}

Error response example

400 — invalid node identifier in the path:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive integer"
  }
}

Errors

HTTP Code Description
HTTP200 CodeWarning: 299 DescriptionThe filter is ignored by default; previous data is preserved and the warning is sent in the Warning header.
HTTP400 (strict mode only) CodeUNSUPPORTED_FILTER DescriptionThe server mode is disabled by default; until it is enabled, the endpoint preserves HTTP 200 and the previous data.
HTTP400 CodeINVALID_PARAMS DescriptionThe node identifier in the path is not a positive integer
HTTP403 CodeSCOPE_DENIED DescriptionThe key is missing the humanresources scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no Bitrix24 tokens configured

Full list of common API errors — Errors.

See also