метод REST scope: entity

entity.section.get

Получить список разделов хранилища

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

Описание

Метод entity.section.get получает список разделов хранилища данных приложения.

Метод работает только в контексте приложения.

Параметры

ENTITY string необязательный

Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища.

Получить идентификатор можно методом entity.get

SORT object необязательный

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n
}

где:
- field_n — поле сортировки
- value_n — направление сортировки: ASC или DESC

Список доступных полей для сортировки смотрите в разделе Тип section.

По умолчанию используется {"ID":"ASC"}.

Пример: {"NAME":"ASC","ID":"DESC"}

FILTER object необязательный

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n
}

где:
- field_n — поле фильтрации
- value_n — значение фильтра

Список доступных полей для фильтрации смотрите в разделе Тип section.

К ключам field_n можно добавлять префиксы:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- = — равно (по умолчанию)
- != или ! — не равно
- >< — диапазон
- !>< — не в диапазоне
- % — LIKE
- !% — NOT LIKE
- ? — проверка на null/not null

start integer необязательный

Параметр постраничной навигации.

Размер страницы фиксирован: 50 записей.

Формула для получения N-й страницы:
start = (N - 1) * 50

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

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ENTITY":"dish","SORT":{"NAME":"ASC"},"FILTER":{"ACTIVE":"Y"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/entity.section.get

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "671",
            "CODE": null,
            "TIMESTAMP_X": "2026-03-23T17:15:51+03:00",
            "DATE_CREATE": "2026-03-23T17:15:51+03:00",
            "CREATED_BY": "577",
            "MODIFIED_BY": "577",
            "ACTIVE": "Y",
            "SORT": "500",
            "NAME": "Родительский раздел",
            "PICTURE": null,
            "DETAIL_PICTURE": null,
            "DESCRIPTION": null,
            "LEFT_MARGIN": "1",
            "RIGHT_MARGIN": "6",
            "DEPTH_LEVEL": "1",
            "ENTITY": "dish",
            "SECTION": null
        },
        {
            "ID": "669",
            "CODE": null,
            "TIMESTAMP_X": "2026-03-23T17:14:22+03:00",
            "DATE_CREATE": "2026-03-23T17:14:22+03:00",
            "CREATED_BY": "577",
            "MODIFIED_BY": "577",
            "ACTIVE": "Y",
            "SORT": "500",
            "NAME": "Тестовый раздел",
            "PICTURE": null,
            "DETAIL_PICTURE": null,
            "DESCRIPTION": null,
            "LEFT_MARGIN": "7",
            "RIGHT_MARGIN": "8",
            "DEPTH_LEVEL": "1",
            "ENTITY": "dish",
            "SECTION": null
        },
        {
            "ID": "673",
            "CODE": null,
            "TIMESTAMP_X": "2026-03-23T17:16:37+03:00",
            "DATE_CREATE": "2026-03-23T17:16:37+03:00",
            "CREATED_BY": "577",
            "MODIFIED_BY": "577",
            "ACTIVE": "Y",
            "SORT": "500",
            "NAME": "Тестовый раздел",
            "PICTURE": null,
            "DETAIL_PICTURE": null,
            "DESCRIPTION": null,
            "LEFT_MARGIN": "4",
            "RIGHT_MARGIN": "5",
            "DEPTH_LEVEL": "2",
            "ENTITY": "dish",
            "SECTION": "671"
        },
        {
            "ID": "675",
            "CODE": "testovyy-razdel",
            "TIMESTAMP_X": "2026-03-23T17:42:32+03:00",
            "DATE_CREATE": "2026-03-23T17:42:32+03:00",
            "CREATED_BY": "577",
            "MODIFIED_BY": "577",
            "ACTIVE": "Y",
            "SORT": "500",
            "NAME": "Тестовый раздел",
            "PICTURE": null,
            "DETAIL_PICTURE": null,
            "DESCRIPTION": "Описание тестового раздела",
            "LEFT_MARGIN": "2",
            "RIGHT_MARGIN": "3",
            "DEPTH_LEVEL": "2",
            "ENTITY": "dish",
            "SECTION": "671"
        }
    ],
    "total": 4,
    "time": {
        "start": 1774338416,
        "finish": 1774338416.415466,
        "duration": 0.4154660701751709,
        "processing": 0,
        "date_start": "2026-03-24T10:46:56+03:00",
        "date_finish": "2026-03-24T10:46:56+03:00",
        "operating_reset_at": 1774339016,
        "operating": 0
    }
}

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

result section[]

Список разделов хранилища

total integer

Общее количество разделов в выборке

next integer

Смещение для получения следующей страницы (если есть)

time time

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

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

HTTP-статус: 400

{
    "error": "ERROR_ARGUMENT",
    "error_description": "Argument 'ENTITY' is null or empty",
    "argument": "ENTITY"
}
Код Описание Значение
ERROR_ARGUMENT Argument 'ENTITY' is null or empty Параметр ENTITY не передан или пустой после очистки
ERROR_ARGUMENT Entity code is too long. Max length is N characters. Слишком длинное значение ENTITY
ERROR_ENTITY_NOT_FOUND Entity not found Хранилище с переданным ENTITY не найдено

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.