Get the list of departments department.get

Scope: department

Who can execute the method: any user

The department.get method is designed to retrieve a list of departments.

Method Parameters

Required parameters are marked with *

Name `type`	Description
sort `string`	The name of the field to sort by. Sorting works on the following fields: `ID` — department identifier `NAME` — department name `SORT` — sorting order `PARENT` — parent department identifier `UF_HEAD` — department head user identifier
order `string`	Sorting direction: `ASC` — ascending `DESC` — descending
ID `int`	Filter by department identifier
NAME `string`	Filter by department name. The full name of the department should be specified
SORT `int`	Filter by sorting field
PARENT `int`	Filter by parent department identifier
UF_HEAD `int`	Filter by department head identifier
START `integer`	This parameter is used for pagination control. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value `50`. To select the third page of results — the value `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` — the desired page number. Details in the article Features of List Methods

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "sort": "NAME",
            "order": "DESC",
            "PARENT": 1
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/department.get

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "sort": "NAME",
            "order": "DESC",
            "PARENT": 1,
            "auth":"**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/department.get

try
        {
        	const response = await $b24.callMethod(
        		"department.get", {
        			"sort": "NAME",
        			"order": "DESC",
        			"PARENT": 1
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'department.get',
                    [
                        'sort'   => 'NAME',
                        'order'  => 'DESC',
                        'PARENT' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your required data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting departments: ' . $e->getMessage();
        }

BX24.callMethod(
            "department.get", {
                "sort": "NAME",
                "order": "DESC",
                "PARENT": 1
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'department.get',
            [
                'sort' => 'NAME',
                'order' => 'DESC',
                'PARENT' => 1,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
          "result": [
            {
              "ID": "15",
              "NAME": "R&D",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "2",
              "NAME": "Accounting",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "4",
              "NAME": "Marketing and Advertising Department",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "3",
              "NAME": "Sales Department",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "17",
              "NAME": "Legal Department",
              "SORT": 500,
              "PARENT": "1"
            }
          ],
          "total": 5,
          "time": {
            "start": 1736924749.531017,
            "finish": 1736924749.719845,
            "duration": 0.1888279914855957,
            "processing": 0.00179290771484375,
            "date_start": "2025-01-15T07:05:49+00:00",
            "date_finish": "2025-01-15T07:05:49+00:00",
            "operating": 0
          }
        }

Returned Data

Name `type`	Description
result `department[]`	The root element of the response that contains the filtered list of departments
total `integer`	The total number of records found
time `time`	Information about the execution time of the request

Structure department

    {
                "ID": "2",
                "NAME": "Accounting",
                "SORT": 500,
                "PARENT": "1"
            }

Name `type`	Description
ID `int`	Department identifier
NAME `string`	Department name
SORT `int`	Department sorting field
PARENT `int`	Parent department identifier

Error Handling

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

Update Department

Delete Department

Get the list of departments department.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Structure departmentStructure department

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning