Получить параметры элемента или список элементов lists.element.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
listsКто может выполнять метод: пользователь с правом «Чтение» для нужного списка
Метод lists.element.get возвращает элемент или список элементов.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
IBLOCK_TYPE_ID* |
Идентификатор типа инфоблока. Возможные значения:
|
|
IBLOCK_ID* |
Идентификатор инфоблока. Идентификатор можно получить с помощью метода lists.get |
|
IBLOCK_CODE* |
Cимвольный код инфоблока. Код можно получить с помощью метода lists.get Необходимо указать хотя бы один из параметров: |
|
ELEMENT_ID |
Идентификатор элемента. Идентификатор можно получить с помощью метода lists.element.get |
|
ELEMENT_CODE |
Символьный код элемента. Код можно получить с помощью метода lists.element.get Чтобы получить данные элемента, необходимо указать хотя бы один из параметров: |
|
SELECT |
Массив содержит список полей, которые необходимо выбрать. Если поля не указаны, возвращаются все доступные по умолчанию. Доступные поля:
|
|
FILTER |
Объект для фильтрации полей элементов в формате
Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
Если не передать идентификатор элемента и не задать условия для фильтрациии, будут возвращены все элементы списка |
|
ELEMENT_ORDER |
Объект для сортировки полей элементов в формате Направление сортировки может принимать значения:
Не поддерживается сортировка множественных свойств, а также свойств:
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
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>
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 |
Данные элемента или массив элементов. Результат зависит от параметра SELECT. Пустой массив означает, что в списке нет элементов, либо элементы не соответствуют фильтру |
|
total |
Общее количество элементов |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"ERROR_REQUIRED_PARAMETERS_MISSING",
"error_description":"Required parameter is missing"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Required parameter |
Обязательный параметр не передан |
|
|
Iblock not found |
Инфоблок не найден |
|
|
Access denied |
Недостаточно прав для чтения элемента |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |