entity.item.get
Получить список элементов хранилища
Описание
Метод entity.item.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
Список доступных полей для сортировки смотрите в разделе Тип item.
По умолчанию используется {"ID":"ASC"}
FILTER
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n
}
где:
- field_n — поле фильтрации
- value_n — значение фильтра
Список доступных полей для фильтрации смотрите в разделе Тип item.
К ключам 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_v2","SORT":{"DATE_ACTIVE_FROM":"ASC","ID":"ASC"},"FILTER":{">=DATE_ACTIVE_FROM":"2026-03-01T00:00:00+03:00","<DATE_ACTIVE_FROM":"2026-04-01T00:00:00+03:00"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/entity.item.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each item returned in result[]
type EntityItem = {
ID: string
TIMESTAMP_X: ISODate
MODIFIED_BY: string
DATE_CREATE: ISODate
CREATED_BY: string
ACTIVE: string
DATE_ACTIVE_FROM: ISODate | string
DATE_ACTIVE_TO: ISODate | string
SORT: string
NAME: string
PREVIEW_PICTURE: string | null
PREVIEW_TEXT: string | null
DETAIL_PICTURE: string | null
DETAIL_TEXT: string | null
CODE: string | null
ENTITY: string
SECTION: string | null
PROPERTY_VALUES?: Record<string, unknown>
}
try {
// entity.item.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<EntityItem[]>({
method: 'entity.item.get',
params: {
ENTITY: 'dish_v2',
SORT: {
DATE_ACTIVE_FROM: 'ASC',
ID: 'ASC',
},
FILTER: {
'>=DATE_ACTIVE_FROM': '2026-03-01T00:00:00+03:00',
'<DATE_ACTIVE_FROM': '2026-04-01T00:00:00+03:00',
},
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('Items count:', result.length, 'First item:', result[0])
}
} 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 getEntityItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// entity.item.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: 'entity.item.get',
params: {
ENTITY: 'dish_v2',
SORT: {
DATE_ACTIVE_FROM: 'ASC',
ID: 'ASC',
},
FILTER: {
'>=DATE_ACTIVE_FROM': '2026-03-01T00:00:00+03:00',
'<DATE_ACTIVE_FROM': '2026-04-01T00:00:00+03:00',
},
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('Items count:', result.length, 'First item:', result[0])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getEntityItems)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.entity.item.get(
entity="dish_v2",
sort={
"DATE_ACTIVE_FROM": "ASC",
"ID": "ASC",
},
filter={
">=DATE_ACTIVE_FROM": "2026-03-01T00:00:00+03:00",
"<DATE_ACTIVE_FROM": "2026-04-01T00:00:00+03:00",
},
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(
'entity.item.get',
[
'ENTITY' => 'dish_v2',
'SORT' => [
'DATE_ACTIVE_FROM' => 'ASC',
'ID' => 'ASC',
],
'FILTER' => [
'>=DATE_ACTIVE_FROM' => '2026-03-01T00:00:00+03:00',
'<DATE_ACTIVE_FROM' => '2026-04-01T00:00:00+03:00',
],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting entity items: ' . $e->getMessage();
}
BX24.callMethod(
'entity.item.get',
{
ENTITY: 'dish_v2',
SORT: {
DATE_ACTIVE_FROM: 'ASC',
ID: 'ASC',
},
FILTER: {
'>=DATE_ACTIVE_FROM': '2026-03-01T00:00:00+03:00',
'<DATE_ACTIVE_FROM': '2026-04-01T00:00:00+03:00',
},
},
(result) => {
if (result.error()) {
console.error(result.error());
return;
}
console.info(result.data());
if (result.more()) {
result.next();
}
},
);
require_once('crest.php');
$result = CRest::call(
'entity.item.get',
[
'ENTITY' => 'dish_v2',
'SORT' => [
'DATE_ACTIVE_FROM' => 'ASC',
'ID' => 'ASC',
],
'FILTER' => [
'>=DATE_ACTIVE_FROM' => '2026-03-01T00:00:00+03:00',
'<DATE_ACTIVE_FROM' => '2026-04-01T00:00:00+03:00',
],
'start' => 0,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "entity.item.get", b24.Params{
"ENTITY": "dish_v2",
"SORT": b24.Params{
"DATE_ACTIVE_FROM": "ASC",
"ID": "ASC",
},
"FILTER": b24.Params{
">=DATE_ACTIVE_FROM": "2026-03-01T00:00:00+03:00",
"<DATE_ACTIVE_FROM": "2026-04-01T00:00:00+03:00",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("entity.item.get: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
TimestampX string `json:"TIMESTAMP_X"`
ModifiedBy string `json:"MODIFIED_BY"`
DateCreate string `json:"DATE_CREATE"`
CreatedBy string `json:"CREATED_BY"`
Active string `json:"ACTIVE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.TimestampX)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"ID": "2331",
"TIMESTAMP_X": "2026-03-25T12:29:06+03:00",
"MODIFIED_BY": "577",
"DATE_CREATE": "2026-03-25T12:29:06+03:00",
"CREATED_BY": "577",
"ACTIVE": "Y",
"DATE_ACTIVE_FROM": "",
"DATE_ACTIVE_TO": "",
"SORT": "500",
"NAME": "Тестовый элемент",
"PREVIEW_PICTURE": null,
"PREVIEW_TEXT": null,
"DETAIL_PICTURE": null,
"DETAIL_TEXT": null,
"CODE": null,
"ENTITY": "dish",
"SECTION": null
}
],
"total": 1,
"time": {
"start": 1774430946,
"finish": 1774430946.627232,
"duration": 0.6272320747375488,
"processing": 0,
"date_start": "2026-03-25T12:29:06+03:00",
"date_finish": "2026-03-25T12:29:06+03:00",
"operating_reset_at": 1774431546,
"operating": 0
}
}
Возвращаемые данные
result
item[]
Список элементов хранилища
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_ARGUMENT |
Ошибки валидатора фильтра | Переданы невалидные значения параметра FILTER |
ERROR_ENTITY_NOT_FOUND |
Entity not found | Хранилище с переданным ENTITY не найдено |
ACCESS_DENIED |
Access denied! Application context required | Нет контекста приложения (clientId) |

