Получить список подразделений department.get

Scope: department

Кто может выполнять метод: любой пользователь

Метод department.get предназначен для получения списка подразделений.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

sort
string

Название поля, по которому нужна сортировка. Сортировка работает по полям:

  • ID — идентификатор подразделения
  • NAME — название подразделения
  • SORT — порядок сортировки
  • PARENT — идентификатор родительского отдела
  • UF_HEAD — идентификатор пользователя-руководителя отдела

order
string

Направление сортировки:

  • ASC — по возрастанию
  • DESC — по убыванию

ID
int

Фильтр по идентификатору подразделения

NAME
string

Фильтр по имени подразделения. Указывается полное название подразделения

SORT
int

Фильтр по полю сортировки

PARENT
int

Фильтр по идентификатору родительского подразделения

UF_HEAD
int

Фильтр по идентификатору руководителя подразделения

START
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы.

Подробности в статье Особенности списочных методов

Примеры кода

Как использовать примеры в документации

-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);
            // Нужная вам логика обработки данных
            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>';

Обработка ответа

HTTP-статус: 200

{
          "result": [
            {
              "ID": "15",
              "NAME": "R\u0026D",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "2",
              "NAME": "Бухгалтерия",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "4",
              "NAME": "Отдел маркетинга и рекламы",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "3",
              "NAME": "Отдел продаж",
              "SORT": 500,
              "PARENT": "1"
            },
            {
              "ID": "17",
              "NAME": "Юр. отдел",
              "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
          }
        }

Возвращаемые данные

Название
тип

Описание

result
department[]

Корневой элемент ответа, который содержит отфильтрованный список подразделений

total
integer

Общее количество найденных записей

time
time

Информация о времени выполнения запроса

Структура department

    {
                "ID": "2",
                "NAME": "Бухгалтерия",
                "SORT": 500,
                "PARENT": "1"
            }

Название
тип

Описание

ID
int

Иидентификатор подразделения

NAME
string

Название подразделения

SORT
int

Поле сортировки подразделения

PARENT
int

Идентификатор родительского подразделения

Обработка ошибок

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Изменить подразделение
Следующая
Удалить подразделение