Get the list of departments department.get

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: department

Who can execute the method: any user

The department.get method returns a list of active departments in the company structure, for example, all departments within one parent department. Write the filter names ID, NAME, SORT, PARENT, and UF_HEAD in uppercase: the method ignores a filter in any other case.

The method belongs to the previous API version. The REST 3.0 counterpart is humanresources.node.list; method correspondence is described in the section overview.

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 by default:

  • ASC — ascending
  • DESC — descending

ID
integer

Filter by department identifier

NAME
string

Filter by the full department name

SORT
integer

Filter by sorting field. The method accepts the parameter but does not apply it: the response includes departments with any SORT value

PARENT
integer

Filter by parent department identifier. To retrieve the top-level department, pass 0

UF_HEAD
integer

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 -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
        
curl -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
        
// 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 Department = {
          ID: string
          NAME: string
          SORT: number
          PARENT?: string
          UF_HEAD?: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<Department[]>({
            method: 'department.get',
            params: {
              sort: 'NAME',
              order: 'DESC',
              PARENT: 1,
            },
            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(result.map((department) => department.NAME))
          }
        } 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 getDepartments() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'department.get',
                params: {
                  sort: 'NAME',
                  order: 'DESC',
                  PARENT: 1,
                },
                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(result.map((department) => department.NAME))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDepartments)
        </script>
        

Example

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.department.get(
                sort="NAME",
                order="DESC",
                parent=1,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

Example as_list

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.department.get(
                sort="NAME",
                order="DESC",
                parent=1,
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'department.get',
                    [
                        'sort'   => 'NAME',
                        'order'  => 'DESC',
                        'PARENT' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "department.get", b24.Params{
        	"sort":   "NAME",
        	"order":  "DESC",
        	"PARENT": 1,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("department.get: %w", err)
        }
        
        var items []struct {
        	ID     b24.ID `json:"ID"`
        	Name   string `json:"NAME"`
        	Sort   int    `json:"SORT"`
        	Parent string `json:"PARENT"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.Name)
        }
        

Response Handling

HTTP status: 200

{
          "result": [
            {
              "ID": "3",
              "NAME": "Sales Department",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "15",
              "NAME": "R&D",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "4",
              "NAME": "Marketing and Advertising Department",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "17",
              "NAME": "Legal Department",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "2",
              "NAME": "Accounting",
              "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[]

List of departments that match the filter

next
integer

The start value for the next page. The field is absent on the last page

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",
            "UF_HEAD": "1"
        }
        

Name
type

Description

ID
string

Department identifier. The number is returned as a string

NAME
string

Department name

SORT
integer

Department sorting field

PARENT
string

Parent department identifier. The number is returned as a string. The top-level department does not have this field

UF_HEAD
string

Identifier of the department head user. The number is returned as a string. If no head is assigned, the field is absent or equals "0"

Error Handling

The method has no errors of its own. The method ignores an unknown field in sort. If no departments match the filter, result is an empty array.

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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

Continue Learning