Получить параметры элемента или список элементов lists.element.get

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: lists

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

Метод lists.element.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

ELEMENT_ID
integer

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

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

ELEMENT_CODE
string

Символьный код элемента.

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

Чтобы получить данные элемента, необходимо указать хотя бы один из параметров: ELEMENT_ID и ELEMENT_CODE

SELECT
array

Массив содержит список полей, которые необходимо выбрать. Если поля не указаны, возвращаются все доступные по умолчанию.

Доступные поля:

  • ID — идентификатор элемента

  • CODE — код элемента

  • NAME — название элемента

  • IBLOCK_SECTION_ID — идентификатор раздела, в который добавляется элемент

  • CREATED_BY — идентификатор пользователя, создавшего элемент

  • CREATED_USER_NAME — имя пользователя, создавшего элемент (устаревшее)

  • ACTIVE_TO — дата окончания активности (устаревшее)

  • BP_PUBLISHED — публикация в рамках бизнес-процесса (устаревшее)

  • DATE_CREATE — дата создания элемента

  • PREVIEW_TEXT — текст анонса (устаревшее)

  • DETAIL_TEXT — детальный текст (устаревшее)

  • SORT — сортировка

  • PREVIEW_TEXT_TYPE — тип текста анонса (устаревшее)

  • DETAIL_TEXT_TYPE — тип детального текста (устаревшее)

  • PROPERTY_PropertyId — пользовательские свойства

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

FILTER
[object]

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

  • NAME — название элемента

  • IBLOCK_SECTION_ID — идентификатор раздела, в который добавляется элемент

  • CREATED_BY — идентификатор пользователя, создавшего элемент

  • ACTIVE_TO — дата окончания активности (устаревшее)

  • BP_PUBLISHED — публикация в рамках бизнес-процесса (устаревшее)

  • DATE_CREATE — дата создания элемента

  • PREVIEW_TEXT — текст анонса (устаревшее)

  • DETAIL_TEXT — детальный текст (устаревшее)

  • SORT — сортировка

  • PREVIEW_TEXT_TYPE — тип текста анонса (устаревшее)

  • DETAIL_TEXT_TYPE — тип детального текста (устаревшее)

  • PROPERTY_PropertyId — пользовательские свойства

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

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • = — точное совпадение
  • !=, ! — не равно
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, не начинающиеся с «мол»
    • "%мол" — ищет значения, не заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
  • = — равно, точное совпадение, используется по умолчанию
  • != — не равно
  • ! — не равно

Если не передать идентификатор элемента и не задать условия для фильтрациии, будут возвращены все элементы списка

ELEMENT_ORDER
object

Объект для сортировки полей элементов в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Направление сортировки может принимать значения:

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

Не поддерживается сортировка множественных свойств, а также свойств:

  • S:Money — тип деньги
  • PREVIEW_TEXT
  • DETAIL_TEXT
  • S:ECrm — тип привязка к элементам CRM
  • S:map_yandex — тип привязка к Яндекс.Карте
  • S:DiskFile — тип Файл (Диск)
  • IBLOCK_SECTION_ID

start
integer

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

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

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

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

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":47,"ELEMENT_ID":6999,"SELECT":["ID","CODE","NAME","IBLOCK_SECTION_ID","DATE_CREATE","PROPERTY_951","PROPERTY_1003"],"FILTER":{"NAME":"%Тестовый%","<=DATE_CREATE":"2025-12-31",">=DATE_CREATE":"2025-01-01"},"ELEMENT_ORDER":{"NAME":"asc"},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.element.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":47,"ELEMENT_ID":6999,"SELECT":["ID","CODE","NAME","IBLOCK_SECTION_ID","DATE_CREATE","PROPERTY_951","PROPERTY_1003"],"FILTER":{"NAME":"%Тестовый%","<=DATE_CREATE":"2025-12-31",">=DATE_CREATE":"2025-01-01"},"ELEMENT_ORDER":{"NAME":"asc"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.element.get
        
try {
            const response = await $b24.callMethod(
                'lists.element.get',
                {
                    IBLOCK_TYPE_ID: 'lists',
                    IBLOCK_ID: 47,
                    ELEMENT_ID: 6999,
                    SELECT: [
                        'ID',
                        'CODE',
                        'NAME',
                        'IBLOCK_SECTION_ID',
                        'DATE_CREATE',
                        'PROPERTY_951',
                        'PROPERTY_1003'
                    ],
                    FILTER: {
                        NAME: '%Тестовый%',
                        '>=DATE_CREATE': '2025-01-01',
                        '<=DATE_CREATE': '2025-12-31'
                    },
                    ELEMENT_ORDER: {
                        NAME: 'asc'
                    },
                    start: 0
                }
            );
        
            const result = response.getData().result;
            console.log('Fetched elements:', result);
            processResult(result);
        } catch (error) {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.element.get',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_ID' => 47,
                        'ELEMENT_ID' => 6999,
                        'SELECT' => [
                            'ID',
                            'CODE',
                            'NAME',
                            'IBLOCK_SECTION_ID',
                            'DATE_CREATE',
                            'PROPERTY_951',
                            'PROPERTY_1003'
                        ],
                        'FILTER' => [
                            'NAME' => '%Тестовый%',
                            '>=DATE_CREATE' => '2025-01-01',
                            '<=DATE_CREATE' => '2025-12-31'
                        ],
                        'ELEMENT_ORDER' => [
                            'NAME' => 'asc'
                        ],
                        'start' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching list element: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "lists.element.get",
            {
                IBLOCK_TYPE_ID: 'lists',
                IBLOCK_ID: 47,
                ELEMENT_ID: 6999,
                SELECT: [
                    'ID',
                    'CODE',
                    'NAME',
                    `IBLOCK_SECTION_ID`,
                    'DATE_CREATE',
                    'PROPERTY_951',
                    'PROPERTY_1003'
                ],
                FILTER: {
                    NAME: '%Тестовый%',
                    '>=DATE_CREATE': '2025-01-01',
                    '<=DATE_CREATE': '2025-12-31'
                },
                ELEMENT_ORDER: {
                    NAME: 'asc'
                }
            },
            function(res) {
                if (res.error()) {
                    console.error(res.error());
                } else {
                    console.log(res.data());
        
                    if (res.more()) {
                        res.next();
                    }
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'lists.element.get',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_ID' => 47,
                'ELEMENT_ID' => 6999,
                'SELECT' => [
                    'ID',
                    'CODE',
                    'NAME',
                    'IBLOCK_SECTION_ID',
                    'DATE_CREATE',
                    'PROPERTY_951',
                    'PROPERTY_1003'
                ],
                'FILTER' => [
                    'NAME' => '%Тестовый%',
                    '>=DATE_CREATE' => '2025-01-01',
                    '<=DATE_CREATE' => '2025-12-31'
                ],
                'ELEMENT_ORDER' => [
                    'NAME' => 'asc'
                ],
                'start' => 0
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": [
                {
                "ID": "6999",
                "NAME": "Тестовый элемент",
                "IBLOCK_SECTION_ID": null,
                "CREATED_BY": "1269",
                "CODE": "test_element",
                "PROPERTY_951": {
                    "3743": "1269",
                    "3745": "1271"
                },
                "PROPERTY_1003": {
                    "3747": "12/31/2024 11:59:59 pm"
                }
                }
            ],
            "total": 1,
            "time": {
                "start": 1763656328,
                "finish": 1763656328.442951,
                "duration": 0.442950963973999,
                "processing": 0,
                "date_start": "2025-11-19T14:32:08+03:00",
                "date_finish": "2025-11-19T14:32:08+03:00",
                "operating_reset_at": 1763656928,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
array

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

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

total
integer

Общее количество элементов

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

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

ERROR_IBLOCK_NOT_FOUND

Iblock not found

Инфоблок не найден

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

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

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