Get Information About the Department im.department.get

Scope: im

Who can execute the method: any intranet user, except bots

The method im.department.get retrieves data about departments by their ID identifiers.

Method Parameters

Required parameters are marked with *

Name
type

Description

ID*
array

An array of department identifiers. You can pass a string with a JSON array of identifiers.

You can obtain the department ID using the get department list method or the search departments by name method

USER_DATA
string

Return data about the department head.

Possible values:

Y — yes
N — no

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":[3,7],"USER_DATA":"Y"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.department.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ID":[3,7],"USER_DATA":"Y","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.department.get

try
        {
            const response = await $b24.callMethod(
                'im.department.get',
                {
                    ID: [3, 7],
                    USER_DATA: 'Y'
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.department.get',
                    [
                        'ID' => [3, 7],
                        'USER_DATA' => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.department.get',
            {
                ID: [3, 7],
                USER_DATA: 'Y'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.department.get',
            [
                'ID' => [3, 7],
                'USER_DATA' => 'Y',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

When USER_DATA = 'N':

{
            "result": [
                {
                    "id": 7,
                    "name": "Development Department",
                    "full_name": "Development Department / mysite.com",
                    "manager_user_id": 103
                },
                {
                    "id": 3,
                    "name": "Finance Department",
                    "full_name": "Finance Department / mysite.com",
                    "manager_user_id": 13
                }
            ],
            "time": {
                "start": 1772527966,
                "finish": 1772527966.081649,
                "duration": 0.0816490650177002,
                "processing": 0,
                "date_start": "2026-03-03T11:52:46+01:00",
                "date_finish": "2026-03-03T11:52:46+01:00",
                "operating_reset_at": 1772528566,
                "operating": 0
            }
        }

When USER_DATA = 'Y':

{
            "result": [
                {
                    "id": 7,
                    "name": "Development Department",
                    "full_name": "Development Department / mysite.com",
                    "manager_user_id": 103,
                    "manager_user_data": {
                        "id": 103,
                        "active": true,
                        "name": "Anna Peterson",
                        "first_name": "Anna",
                        "last_name": "Peterson",
                        "work_position": "Head of Development Department",
                        "color": "#4ba984",
                        "avatar": "https://mysite.com/upload/avatars/anna-peterson.jpg",
                        "avatar_hr": "https://mysite.com/upload/avatars/anna-peterson.jpg",
                        "gender": "F",
                        "birthday": "",
                        "extranet": false,
                        "network": false,
                        "bot": false,
                        "connector": false,
                        "external_auth_id": "socservices",
                        "status": "online",
                        "idle": false,
                        "last_activity_date": "2025-11-06T16:59:28+01:00",
                        "mobile_last_date": false,
                        "desktop_last_date": false,
                        "absent": false,
                        "departments": [
                            1,
                            7
                        ],
                        "phones": false,
                        "bot_data": null,
                        "type": "user",
                        "website": "",
                        "email": "anna.peterson@mysite.com"
                    }
                },
                {
                    "id": 3,
                    "name": "Finance Department",
                    "full_name": "Finance Department / mysite.com",
                    "manager_user_id": 13,
                    "manager_user_data": {
                        "id": 13,
                        "active": true,
                        "name": "John Smith",
                        "first_name": "John",
                        "last_name": "Smith",
                        "work_position": "Chief Accountant",
                        "color": "#728f7a",
                        "avatar": "https://mysite.com/upload/avatars/john-smith.jpg",
                        "avatar_hr": "https://mysite.com/upload/avatars/john-smith.jpg",
                        "gender": "M",
                        "birthday": "10-09",
                        "extranet": false,
                        "network": false,
                        "bot": false,
                        "connector": false,
                        "external_auth_id": "socservices",
                        "status": "online",
                        "idle": false,
                        "last_activity_date": "2024-02-19T00:40:41+01:00",
                        "mobile_last_date": false,
                        "desktop_last_date": false,
                        "absent": false,
                        "departments": [
                            9,
                            3
                        ],
                        "phones": {
                            "personal_mobile": "12134567890",
                            "inner_phone": "55"
                        },
                        "bot_data": null,
                        "type": "user",
                        "website": "",
                        "email": "john.smith@mysite.com"
                    }
                }
            ],
            "time": {
                "start": 1772461967,
                "finish": 1772461967.997741,
                "duration": 0.9977409839630127,
                "processing": 0,
                "date_start": "2026-03-02T17:32:47+01:00",
                "date_finish": "2026-03-02T17:32:47+01:00",
                "operating_reset_at": 1772462567,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
array

List of departments (detailed description).

When USER_DATA = 'N', it contains a brief description of the departments; when USER_DATA = 'Y', it additionally contains an object with data about the department head

time
time

Information about the execution time of the request

Department Object

Name `type`	Description
id `integer`	Department identifier
name `string`	Department name
full_name `string`	Full name of the department in the company structure
manager_user_id `integer`	Identifier of the department head
manager_user_data `object`	Data about the department head (detailed description). Returned only when `USER_DATA = 'Y'`

Manager User Data Object

Name `type`	Description
id `integer`	User identifier
active `boolean`	User activity status
name `string`	User's full name
first_name `string`	User's first name
last_name `string`	User's last name
work_position `string`	User's job title
color `string`	User's color in hex format
avatar `string`	Link to the avatar
avatar_hr `string`	Link to the high-resolution avatar
gender `string`	User's gender
birthday `string`	Birthday in `DD-MM` format or an empty string
extranet `boolean`	External user status
network `boolean`	Bitrix24 Network user status
bot `boolean`	Bot status
connector `boolean`	Open Channels user status
external_auth_id `string`	External authorization code
status `string`	User status
idle `datetime`	User's idle date or `false`
last_activity_date `datetime`	User's last activity date
mobile_last_date `datetime`	User's last activity date in the mobile app or `false`
desktop_last_date `datetime`	User's last activity date in the desktop app or `false`
absent `datetime`	User's absence end date or `false`
departments `array`	Array of department identifiers
phones `object`	User's phones or `false` (detailed description)
bot_data `object`	Bot data or `null`
type `string`	User type
website `string`	User's website
email `string`	User's email

Object phones

Name `type`	Description
personal_mobile `string`	Mobile phone
inner_phone `string`	Internal phone

Error Handling

HTTP Status: 400

{
            "error": "INVALID_FORMAT",
            "error_description": "A wrong format for the ID field is passed"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	`INVALID_FORMAT`	A wrong format for the ID field is passed	The required parameter `ID` is not provided, is incorrectly provided, or is empty
`403`	`ACCESS_ERROR`	Only intranet users have access to this method	The method is not available for extranet users and bots

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Get List of Department Managers

Get Information About the Department im.department.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Department ObjectDepartment Object

Manager User Data ObjectManager User Data Object

Object phonesObject phones

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning