Получить параметры раздела или список разделов универсального списка lists.section.get

Scope: lists

Кто может выполнять метод: пользователь с правом «Чтение» для нужного списка

Метод lists.section.get возвращает раздел или список разделов.

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

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

Название
тип

Описание

IBLOCK_TYPE_ID*
string

Идентификатор типа инфоблока. Возможные значения:

  • lists — тип инфоблока списка
  • bitrix_processes — тип инфоблока процессов
  • lists_socnet — тип инфоблока списков групп

IBLOCK_ID*
integer

Идентификатор инфоблока.

Идентификатор можно получить с помощью метода lists.get

IBLOCK_CODE*
string

Cимвольный код инфоблока.

Код можно получить с помощью метода lists.get

Необходимо указать хотя бы один из параметров: IBLOCK_ID или IBLOCK_CODE

FILTER
object

Объект для фильтрации разделов {"field_1": "value_1", ... "field_N": "value_N"}. Фильтруемое поле может принимать значения:

  • ID — идентификатор раздела
  • CODE — символьный код раздела
  • XML_ID — внешний идентификатор (XML ID)
  • EXTERNAL_ID — внешний идентификатор раздела
  • NAME — название раздела
  • ACTIVE — признак активности
  • GLOBAL_ACTIVE — глобальная активность
  • IBLOCK_ACTIVE — признак активности инфоблока
  • IBLOCK_NAME — название инфоблока
  • IBLOCK_TYPE — идентификатор типа инфоблока
  • IBLOCK_XML_ID — внешний идентификатор инфоблока (XML ID)
  • IBLOCK_EXTERNAL_ID — внешний идентификатор инфоблока
  • DEPTH_LEVEL — уровень вложенности
  • LEFT_MARGIN — левая граница дерева
  • RIGHT_MARGIN — правая граница дерева
  • LEFT BORDER — левая граница
  • RIGHT BORDER — правая граница
  • TIMESTAMP_X — время последнего изменения
  • DATE_CREATE — дата создания раздела
  • CREATED_BY — идентификатор пользователя, создавшего раздел
  • MODIFIED_BY — идентификатор пользователя, изменившего раздел

Перед названием фильтруемого поля можно указать тип фильтрации:

  • ! — не равно
  • < — меньше
  • <= — меньше либо равно
  • > — больше
  • >= — больше либо равно
  • % — поиск по подстроке

По умолчанию записи не фильтруются

SELECT
array

Массив с полями для выборки. Доступные поля:

  • ID — идентификатор раздела
  • CODE — символьный код раздела
  • XML_ID — внешний идентификатор (XML ID)
  • EXTERNAL_ID — внешний идентификатор раздела
  • IBLOCK_SECTION_ID — идентификатор родительского раздела
  • TIMESTAMP_X — время последнего изменения
  • SORT — сортировка
  • NAME — название раздела
  • ACTIVE — признак активности
  • GLOBAL_ACTIVE — глобальная активность
  • PICTURE — картинка (устаревшее)
  • DESCRIPTION — описание (устаревшее)
  • DESCRIPTION_TYPE — тип описания (устаревшее)
  • LEFT_MARGIN — левая граница дерева
  • RIGHT_MARGIN — правая граница дерева
  • DEPTH_LEVEL — уровень вложенности
  • SEARCHABLE_CONTENT — поисковый контент
  • SECTION_PAGE_URL — URL страницы (устаревшее)
  • MODIFIED_BY — идентификатор пользователя, изменившего раздел
  • DATE_CREATE — дата создания раздела
  • CREATED_BY — идентификатор пользователя, создавшего раздел
  • DETAIL_PICTURE — детальная картинка (устаревшее)

Если поля не указаны, возвращаются все доступные по умолчанию

Чтобы получить данные одного раздела, укажите его идентификатор в FILTER. Без фильтра метод вернет список всех разделов

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":95,"FILTER":{"ID":169,"ACTIVE":"Y","NAME":"%маркетинг%","<=DATE_CREATE":"2025-12-31",">=DATE_CREATE":"2025-01-01"},"SELECT":["ID","CODE","XML_ID","EXTERNAL_ID","IBLOCK_SECTION_ID","TIMESTAMP_X","SORT","NAME","ACTIVE","GLOBAL_ACTIVE","LEFT_MARGIN","RIGHT_MARGIN","DEPTH_LEVEL","SEARCHABLE_CONTENT","MODIFIED_BY","DATE_CREATE","CREATED_BY"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.section.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":95,"FILTER":{"ID":169,"ACTIVE":"Y","NAME":"%маркетинг%","<=DATE_CREATE":"2025-12-31",">=DATE_CREATE":"2025-01-01"},"SELECT":["ID","CODE","XML_ID","EXTERNAL_ID","IBLOCK_SECTION_ID","TIMESTAMP_X","SORT","NAME","ACTIVE","GLOBAL_ACTIVE","LEFT_MARGIN","RIGHT_MARGIN","DEPTH_LEVEL","SEARCHABLE_CONTENT","MODIFIED_BY","DATE_CREATE","CREATED_BY"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.section.get
        
try
        {
            const response = await $b24.callMethod(
                'lists.section.get',
                {
                    IBLOCK_TYPE_ID: 'lists',
                    IBLOCK_ID: 95,
                    FILTER: {
                        ID: 169,
                        ACTIVE: 'Y',
                        NAME: '%маркетинг%',
                        '>=DATE_CREATE': '2025-01-01',
                        '<=DATE_CREATE': '2025-12-31'
                    },
                    SELECT: [
                        'ID',
                        'CODE',
                        'XML_ID',
                        'EXTERNAL_ID',
                        'IBLOCK_SECTION_ID',
                        'TIMESTAMP_X',
                        'SORT',
                        'NAME',
                        'ACTIVE',
                        'GLOBAL_ACTIVE',
                        'LEFT_MARGIN',
                        'RIGHT_MARGIN',
                        'DEPTH_LEVEL',
                        'SEARCHABLE_CONTENT',
                        'MODIFIED_BY',
                        'DATE_CREATE',
                        'CREATED_BY',
                    ]
                }
            );
            
            const result = response.getData().result;
            console.log('Retrieved sections:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.section.get',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_ID' => 95,
                        'FILTER' => [
                            'ID' => 169,
                            'ACTIVE' => 'Y',
                            'NAME' => '%маркетинг%',
                            '>=DATE_CREATE' => '2025-01-01',
                            '<=DATE_CREATE' => '2025-12-31'
                        ],
                        'SELECT' => [
                            'ID',
                            'CODE',
                            'XML_ID',
                            'EXTERNAL_ID',
                            'IBLOCK_SECTION_ID',
                            'TIMESTAMP_X',
                            'SORT',
                            'NAME',
                            'ACTIVE',
                            'GLOBAL_ACTIVE',
                            'LEFT_MARGIN',
                            'RIGHT_MARGIN',
                            'DEPTH_LEVEL',
                            'SEARCHABLE_CONTENT',
                            'MODIFIED_BY',
                            'DATE_CREATE',
                            'CREATED_BY',
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving section: ' . $e->getMessage();
        }
        
BX24.callMethod(
        'lists.section.get',
        {
            IBLOCK_TYPE_ID: 'lists',
            IBLOCK_ID: 95,
            
            FILTER: {
                'ID': 169,
                'ACTIVE': 'Y',
                'NAME': '%маркетинг%',
                '>=DATE_CREATE': '2025-01-01',
                '<=DATE_CREATE': '2025-12-31'
            },
        
            SELECT: [
                'ID',
                'CODE',
                'XML_ID',
                'EXTERNAL_ID',
                'IBLOCK_SECTION_ID',
                'TIMESTAMP_X',
                'SORT',
                'NAME',
                'ACTIVE',
                'GLOBAL_ACTIVE',
                'LEFT_MARGIN',
                'RIGHT_MARGIN',
                'DEPTH_LEVEL',
                'SEARCHABLE_CONTENT',
                'MODIFIED_BY',
                'DATE_CREATE',
                'CREATED_BY',
            ]
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.log(result.data());
            }
        }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'lists.section.get',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_ID' => 95,
                'FILTER' => [
                    'ID' => 169,
                    'ACTIVE' => 'Y',
                    'NAME' => '%маркетинг%',
                    '>=DATE_CREATE' => '2025-01-01',
                    '<=DATE_CREATE' => '2025-12-31'
                ],
                'SELECT' => [
                    'ID',
                    'CODE',
                    'XML_ID',
                    'EXTERNAL_ID',
                    'IBLOCK_SECTION_ID',
                    'TIMESTAMP_X',
                    'SORT',
                    'NAME',
                    'ACTIVE',
                    'GLOBAL_ACTIVE',
                    'LEFT_MARGIN',
                    'RIGHT_MARGIN',
                    'DEPTH_LEVEL',
                    'SEARCHABLE_CONTENT',
                    'MODIFIED_BY',
                    'DATE_CREATE',
                    'CREATED_BY',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "169",
                    "CODE": "marketing_documents",
                    "XML_ID": "ext_marketing_docs_002",
                    "EXTERNAL_ID": "ext_marketing_docs_002",
                    "IBLOCK_SECTION_ID": null,
                    "TIMESTAMP_X": "10/27/2025 12:00:30 pm",
                    "SORT": "600",
                    "NAME": "Обновленные документы маркетинга",
                    "ACTIVE": "Y",
                    "GLOBAL_ACTIVE": "Y",
                    "LEFT_MARGIN": "17",
                    "RIGHT_MARGIN": "18",
                    "DEPTH_LEVEL": "1",
                    "SEARCHABLE_CONTENT": "ОБНОВЛЕННЫЕ ДОКУМЕНТЫ МАРКЕТИНГА\r\n",
                    "MODIFIED_BY": "1269",
                    "DATE_CREATE": "10/27/2025 11:36:56 am",
                    "CREATED_BY": "1269"
                }
            ],
            "total": 1,
            "time": {
                "start": 1761556287,
                "finish": 1761556287.844517,
                "duration": 0.8445169925689697,
                "processing": 0,
                "date_start": "2025-10-27T12:11:27+03:00",
                "date_finish": "2025-10-27T12:11:27+03:00",
                "operating_reset_at": 1761556887,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
array

Данные раздела или массив разделов. Результат зависит от параметра SELECT.

Пустой массив означает, что в списке нет разделов, либо разделы не соответствуют фильтру

time
time

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

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

HTTP-статус: 400

{
            "error":"ERROR_REQUIRED_PARAMETERS_MISSING",
            "error_description":"Required parameter is missing"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

ERROR_REQUIRED_PARAMETERS_MISSING

Required parameter X is missing

Обязательный параметр не передан

ACCESS_DENIED

Access denied

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

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

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

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

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