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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: lists

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

Метод lists.element.get возвращает элемент или список элементов.

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

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

Название
тип

Описание

IBLOCK_TYPE_ID*
string

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

Стандартные типы:

  • lists — универсальные списки
  • bitrix_processes — процессы
  • lists_socnet — списки групп

В коробочной версии можно также указать идентификатор произвольного существующего типа инфоблоков. IBLOCK_ID или IBLOCK_CODE должен указывать на инфоблок этого типа. Доступ к операции определяется стандартными правами пользователя на инфоблок, раздел или элемент

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
// 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

// Shape of each element returned in result[]
type ElementData = {
  ID: string
  NAME: string
  CODE: string
  IBLOCK_SECTION_ID: string | null
  CREATED_BY: string
  PROPERTY_951: Record<string, string>
  PROPERTY_1003: Record<string, string>
}

try {
  // lists.element.get returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<ElementData[]>({
    method: 'lists.element.get',
    params: {
      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: '%Test%',
        '>=DATE_CREATE': '2025-01-01',
        '<=DATE_CREATE': '2025-12-31',
      },
      ELEMENT_ORDER: {
        NAME: 'asc',
      },
      start: 0,
    },
    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('Fetched elements:', result.length, result[0]?.ID, result[0]?.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 getListElements() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // lists.element.get returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'lists.element.get',
        params: {
          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: '%Test%',
            '>=DATE_CREATE': '2025-01-01',
            '<=DATE_CREATE': '2025-12-31',
          },
          ELEMENT_ORDER: {
            NAME: 'asc',
          },
          start: 0,
        },
        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('Fetched elements:', result.length, result[0]?.ID, result[0]?.NAME)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getListElements)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

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",
}

try:
    bitrix_response = client.lists.element.get(
        iblock_type_id='lists',
        iblock_id=47,
        element_id=6999,
        select=select,
        filter=filter,
        element_order=element_order,
        start=0,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "lists.element.get", b24.Params{
	"IBLOCK_TYPE_ID": "lists",
	"IBLOCK_ID":      47,
	"ELEMENT_ID":     6999,
	"SELECT":         []string{"ID", "CODE", "NAME", "IBLOCK_SECTION_ID", "DATE_CREATE", "PROPERTY_951", "PROPERTY_1003"},
	"FILTER": b24.Params{
		"NAME":          "%Тестовый%",
		"<=DATE_CREATE": "2025-12-31",
		">=DATE_CREATE": "2025-01-01",
	},
	"ELEMENT_ORDER": b24.Params{
		"NAME": "asc",
	},
	"start": 0,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("lists.element.get: %w", err)
}

var items []struct {
	ID        b24.ID `json:"ID"`
	Name      string `json:"NAME"`
	CreatedBy string `json:"CREATED_BY"`
	Code      string `json:"CODE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.Name)
}

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

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
string

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

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

Код

Описание

Значение

ERROR_REQUIRED_PARAMETERS_MISSING

Required parameter X is missing

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

ERROR_IBLOCK_NOT_FOUND

Iblock not found

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

ACCESS_DENIED

Access denied

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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