Для AI-агентов: markdown этой страницы — /docs-content/entities/pages/block-content.md индекс документации — /llms.txt

Чтение содержимого блока

GET /v1/pages/:pageId/blocks/:blockId/content

Возвращает HTML блока страницы и данные для его редактирования. Черновик читается всегда, поэтому видны и неопубликованные изменения.

Требуется скоуп landing. Ключ в режиме «только чтение» получает ответ. Тело запроса не передаётся.

Параметры

Параметр Тип Обяз. Описание
ПараметрpageId (path) Типnumber Обяз.да ОписаниеID страницы. Список: GET /v1/pages
ПараметрblockId (path) Типnumber Обяз.да ОписаниеID блока страницы pageId. Список: GET /v1/pages/:pageId/blocks
Параметрscope (query) Типstring Обяз.нет ОписаниеТип сайта: KNOWLEDGE — база знаний, GROUP — сайт рабочей группы, MAINPAGE — главная страница. Для страниц остальных сайтов параметр не передают

Примеры

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/pages/3/blocks/4975/content" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/pages/3/blocks/4975/content" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript
const response = await fetch("https://vibecode.bitrix24.tech/v1/pages/3/blocks/4975/content", {
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

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

javascript
const response = await fetch("https://vibecode.bitrix24.tech/v1/pages/3/blocks/4975/content", {
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеСодержимое блока
Полеdata.html Типstring ОписаниеHTML блока внутри контейнера с классом block-wrapper
Полеdata.anchor Типstring ОписаниеЯкорь блока. Необязательное поле
Полеdata.nodes Типobject | array ОписаниеОписание редактируемых узлов: ключ — CSS-селектор узла. Необязательное поле
Полеdata.cards Типobject | array ОписаниеОписание карточек блока: ключ — CSS-селектор карточки. Необязательное поле
Полеdata.style Типobject | array ОписаниеДоступные стили блока и его узлов. Необязательное поле
Полеdata.attrs Типobject | array ОписаниеРедактируемые атрибуты узлов. Необязательное поле
Полеdata.css Типarray ОписаниеПути к CSS-файлам блока. Необязательное поле
Полеdata.js Типarray ОписаниеПути к JavaScript-файлам блока. Необязательное поле
Полеdata.php Типboolean Описаниеtrue — блок содержит PHP-код, правка его содержимого ограничена. Необязательное поле

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

JSON
{
  "success": true,
  "data": {
    "html": "<div id=\"block4975\" data-id=\"4975\" class=\"block-wrapper block-26-3-separator\"><div class=\"landing-block g-pt-0 g-pb-0 g-height-70 g-my-minus-2 g-fill-first g-fill-second g-height-50--md landing-block-separator\" style=\"--fill-first: #ffffff;--fill-second: hsla(0, 0%, 86%, 1);\">\r\n\t<svg class=\"g-width-100x g-height-100x\" viewbox=\"0 0 1100 200\" preserveaspectratio=\"none\" xmlns=\"http://www.w3.org/2000/svg\">\r\n\t\t<path class=\"fill-first\" d=\"M0 0H1100V2V3H1097.19L550 198L2.80612 3H0V2V0Z\" />\r\n\t\t<path class=\"fill-second\" d=\"M1100 197V198V200H0V198V197V2L547.194 197H552.806L1100 2V197Z\" />\r\n\t</svg>\r\n</div></div>",
    "nodes": [],
    "cards": [],
    "style": {
      "block": {
        "type": [
          "display",
          "fill-first",
          "fill-second",
          "height-increased--md"
        ]
      },
      "nodes": []
    },
    "attrs": [],
    "anchor": "b4975",
    "css": [],
    "js": [
      "/bitrix/js/pull/protobuf/protobuf.min.js?178773668523214",
      "/bitrix/js/pull/protobuf/model.min.js?178773668521204",
      "/bitrix/js/main/core/core_promise.min.js?17906071592494",
      "/bitrix/js/rest/client/rest.client.min.js?16015491189240",
      "/bitrix/js/pull/client/pull.client.min.js?174471771449849"
    ],
    "php": false
  }
}

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

404 — блока нет на странице pageId:

JSON
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Block or page not found."
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодENTITY_NOT_FOUND ОписаниеBlock or page not found. — блока или страницы с такими ID нет либо блок принадлежит другой странице
HTTP400 КодINVALID_PARAMS ОписаниеpageId and blockId must be positive safe integers. — pageId или blockId не является положительным целым числом
HTTP400 КодINVALID_SCOPE Описаниеscope не равен KNOWLEDGE, GROUP или MAINPAGE
HTTP502 КодBITRIX_INVALID_RESPONSE ОписаниеBitrix24 returned an invalid block., Bitrix24 returned a different block. или Bitrix24 returned invalid block content. — Битрикс24 вернул неожиданный результат
HTTP502 КодBITRIX_INVALID_RESPONSE ОписаниеBitrix24 block response exceeds the 8 MiB limit. — ответ Битрикс24 больше 8 МиБ
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил запрос. Текст ошибки приходит от Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа landing
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя Битрикс24, от имени которого выпущен ключ, нет прав на чтение страницы
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеКлюч в X-Api-Key не найден или отозван
HTTP409 КодLANDING_MODULE_NOT_ENABLED ОписаниеМодуль «Сайты» недоступен на портале
HTTP409 КодPORTAL_ADDRESS_CHANGED ОписаниеКоробочный Битрикс24 переехал на новый адрес, а вебхук ключа выписан на прежний. Выпустите вебхук ключа заново
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов к Битрикс24. Повторите запрос через 1-2 секунды
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 не ответил или ответил ошибкой сервера
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил за отведённое время

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

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

  • Пустой словарь приходит пустым массивом. У блока без узлов, карточек или атрибутов поля nodes, cards, attrs равны [], а не {}. Проверяйте тип перед обходом ключей.
  • Данные редактирования дополняются из манифеста. Недостающее на верхнем уровне ответа Битрикс24 поле nodes, cards, style или attrs берётся из манифеста блока.
  • Ссылки с учётными данными скрываются. Строка ответа, в которой есть адрес вебхука Битрикс24 или токен в параметрах адреса, приходит со значением [REDACTED]. Если такой адрес есть в HTML, значением [REDACTED] заменяется весь html.

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