Получить элемент

GET /v1/lists/:iblockId/elements/:elementId

Возвращает один элемент списка по его идентификатору.

Параметры

Параметр Тип Обяз. По умолч. Описание
iblockId (path) string да — Числовой идентификатор списка IBLOCK_ID или символьный код IBLOCK_CODE
elementId (path) number да — Идентификатор элемента, положительное целое число
iblockTypeId (query) string нет lists Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы
select (query) string нет — Список возвращаемых полей через запятую. Пользовательское свойство запрашивается как PROPERTY_<id>. Пример: ?select=ID,NAME,PROPERTY_1149

Примеры

curl — личный ключ

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/elements/501 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/elements/501 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/121/elements/501', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Элемент:', data)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/121/elements/501', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Показаны наблюдаемые поля. Состав системных полей задаёт Битрикс24, пользовательские свойства приходят под ключами PROPERTY_<id>.

Поле Тип Описание
success boolean Всегда true при успехе
data.ID string Идентификатор элемента
data.IBLOCK_ID string Идентификатор списка
data.NAME string Название элемента
data.IBLOCK_SECTION_ID string или null Идентификатор раздела, null для элемента вне разделов
data.CODE string или null Символьный код элемента, null если не задан
data.BP_PUBLISHED string Признак публикации: Y или N
data.CREATED_BY string Идентификатор создателя. Поиск — GET /v1/users
data.DATE_CREATE string Дата и время создания
data.MODIFIED_BY string Идентификатор автора последнего изменения. Поиск — GET /v1/users
data.USER_NAME string Имя создателя для отображения
data.PROPERTY_<id> object Значения пользовательского свойства как отображение «идентификатор значения — значение». Идентификатор свойства — из Поля списка

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "ID": "501",
    "IBLOCK_ID": "121",
    "NAME": "Пример элемента",
    "IBLOCK_SECTION_ID": null,
    "CODE": null,
    "BP_PUBLISHED": "Y",
    "CREATED_BY": "17",
    "DATE_CREATE": "10/12/2025 12:53:50 pm",
    "MODIFIED_BY": "17",
    "USER_NAME": "Иван Петров",
    "PROPERTY_1149": { "3801": "78" }
  }
}

Пример ответа при ошибке

404 — элемент не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ELEMENT_NOT_FOUND",
    "message": "Element not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS elementId не является положительным целым числом
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в набор lists, bitrix_processes, lists_socnet
404 ELEMENT_NOT_FOUND Элемент с указанным elementId в списке не найден
403 BITRIX_ACCESS_DENIED Нет доступа к списку или список не существует
409 LISTS_MODULE_NOT_ENABLED На портале не подключён модуль «Списки»
403 SCOPE_DENIED Ключу не хватает скоупа lists
401 TOKEN_MISSING У ключа не настроены токены доступа

Полный список общих ошибок API — Ошибки.

Известные особенности

Значение пользовательского свойства приходит не строкой, а отображением «идентификатор значения — значение»: "PROPERTY_1149": { "3801": "78" }, где 3801 — идентификатор конкретного значения, а 78 — само значение. У свойства с несколькими значениями в отображении несколько пар.

Смотрите также