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

Чтение образца каталога

GET /v1/block-repository/:code/content

Возвращает {code,html}, образец HTML из каталога. Отсутствующий образец даёт 404. Код может содержать точки, двоеточие и @; кодируйте компонент пути через encodeURIComponent(code). Блоки приложений repo_N читаются из репозитория текущего портала.

Требуется scope landing. READONLY-ключ может читать. Необязательный query scope=KNOWLEDGE|GROUP|MAINPAGE выбирает контекст страницы. Тело контрактом не предусмотрено. Строки с credential URL заменяются на [REDACTED], при необходимости целиком HTML. Ответ Б24 ограничен 8 MiB; превышение даёт 502.

Метод содержимого не разрешает префикс bitrix: (404); для содержимого используйте код без префикса. Метод манифеста принимает этот префикс.

Параметры запроса

Поле Тип Обязательно Описание
code string yes Непустой код блока, закодированный в пути, например 01.big_with_text_3 или repo_12.
scope string no KNOWLEDGE, GROUP или MAINPAGE; для обычного сайта опускается.

Примеры

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.tech/v1/block-repository/01.big_with_text_3/content" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.tech/v1/block-repository/01.big_with_text_3/content" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch("https://vibecode.bitrix24.tech/v1/block-repository/01.big_with_text_3/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 application

javascript 
const response = await fetch("https://vibecode.bitrix24.tech/v1/block-repository/01.big_with_text_3/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.code string Запрошенный код.
data.html string Образец HTML каталога; может быть [REDACTED].

Ответ

JSON 
{
  "success": true,
  "data": {
    "code": "01.big_with_text_3",
    "html": "<section>Sample</section>"
  }
}

Ошибки

HTTP Код Условие
400 INVALID_PARAMS Некорректный pageId/blockId или пустой code.
400 INVALID_SCOPE Некорректный scope.
401 TOKEN_MISSING Нет авторизации Б24.
403 SCOPE_DENIED У ключа нет scope landing.
403 BITRIX_ACCESS_DENIED Нет прав у пользователя Б24.
404 ENTITY_NOT_FOUND Блок другой страницы, нет образца или файла манифеста.
409 LANDING_MODULE_NOT_ENABLED Модуль «Сайты» недоступен на портале.
422 BITRIX_ERROR Бизнес-отказ Б24; текст сохраняется.
502 BITRIX_INVALID_RESPONSE Неожиданный результат или ответ Б24 больше 8 MiB.

Все системные ошибки.

См. также