Получить список блоков из репозитория landing.block.getrepository

Scope: landing

Кто может выполнять метод: пользователь с доступом к разделу «Сайты и магазины»

Метод landing.block.getrepository возвращает доступные разделы репозитория блоков или данные одного раздела.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

section
string

Код раздела репозитория, например text.

Если параметр не передан, метод вернет все доступные разделы. В этом случае ключами объекта result будут коды разделов.

Кроме стандартных разделов, в ответ могут появляться разделы партнерских приложений и служебные разделы. Чтобы получить актуальные коды разделов, вызовите метод без section.

Если раздел с таким кодом не найден или передана пустая строка, метод вернет false без ошибки

scope
string

Дополнительный верхнеуровневый параметр REST-вызова, который влияет на тип сайта, для которого собирается репозиторий.

Для сайтов типов PAGE, STORE и SMN параметр передавать не нужно. Для GROUP, KNOWLEDGE и MAINPAGE передайте соответствующий scope.

Подробно правила выбора значения описаны в статье Работа с типами сайтов и скоупами.

Если scope не передан, метод использует текущий тип сайта, а если его нельзя определить из контекста, работает как для типа PAGE

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "section": "text"
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getrepository.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "section": "text",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.block.getrepository.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.block.getrepository',
        		{
        			section: 'text'
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.block.getrepository',
                    [
                        'section' => 'text',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting repository blocks: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.block.getrepository',
            {
                section: 'text'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.block.getrepository',
            [
                'section' => 'text',
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }
        

Обработка ответа

HTTP-статус: 200

Пример ответа для запроса с параметром section

{
            "result": {
                "name": "Текст",
                "meta": {
                    "ai_text_placeholder": "text for website, family business, sale of flowers",
                    "ai_text_max_tokens": 150
                },
                "new": false,
                "type": null,
                "specialType": null,
                "separator": false,
                "app_code": false,
                "items": {
                    "03.1.three_cols_big_with_text_and_titles": {
                        "id": null,
                        "name": "Текст в 3 колонки на всю ширину страницы на цветном фоне",
                        "namespace": "bitrix",
                        "new": false,
                        "version": null,
                        "type": [],
                        "section": [
                            "columns",
                            "text"
                        ],
                        "system": false,
                        "description": "Три колонки с заголовками и текстом",
                        "preview": "//example.bitrix24.ru/bitrix/blocks/bitrix/03.1.three_cols_big_with_text_and_titles/preview.jpg",
                        "restricted": false,
                        "repo_id": false,
                        "app_code": false,
                        "only_for_license": "",
                        "requires_updates": false
                    },
                    "repo_405": {
                        "id": null,
                        "new": false,
                        "name": "Блок \"Текст + изображение\" с кнопкой, текст справа, изображение слева",
                        "description": null,
                        "namespace": "krayt.monotovar",
                        "type": [],
                        "section": [
                            "about",
                            "text",
                            "image"
                        ],
                        "preview": "https://krayt.moscow/upload/iblock/5aa/5aabf5b9241876561d5db49c482dcd96.png",
                        "restricted": true,
                        "repo_id": "405",
                        "app_code": "krayt.monotovar",
                        "requires_updates": false
                    }
                }
            },
            "time": {
                "start": 1774521670,
                "finish": 1774521670.823288,
                "duration": 0.8232879638671875,
                "processing": 0,
                "date_start": "2026-03-26T13:41:10+03:00",
                "date_finish": "2026-03-26T13:41:10+03:00",
                "operating_reset_at": 1774522270,
                "operating": 0
            }
        }
        

Пример ответа для запроса без параметра section

{
            "result": {
                "favourite": {
                    "name": "Избранное",
                    "meta": [],
                    "new": false,
                    "type": null,
                    "specialType": null,
                    "separator": false,
                    "app_code": false,
                    "items": {}
                },
                "text": {
                    "name": "Текст",
                    "meta": {
                        "ai_text_placeholder": "text for website, family business, sale of flowers",
                        "ai_text_max_tokens": 150
                    },
                    "new": false,
                    "type": null,
                    "specialType": null,
                    "separator": false,
                    "app_code": false,
                    "items": {
                        "03.1.three_cols_big_with_text_and_titles": {
                            "id": null,
                            "name": "Текст в 3 колонки на всю ширину страницы на цветном фоне",
                            "namespace": "bitrix",
                            "new": false,
                            "version": null,
                            "type": [],
                            "section": [
                                "columns",
                                "text"
                            ],
                            "system": false,
                            "description": "Три колонки с заголовками и текстом",
                            "preview": "//example.bitrix24.ru/bitrix/blocks/bitrix/03.1.three_cols_big_with_text_and_titles/preview.jpg",
                            "restricted": false,
                            "repo_id": false,
                            "app_code": false,
                            "only_for_license": "",
                            "requires_updates": false
                        }
                    }
                }
            },
            "time": {
                "start": 1774521670,
                "finish": 1774521670.823288,
                "duration": 0.8232879638671875,
                "processing": 0,
                "date_start": "2026-03-26T13:41:10+03:00",
                "date_finish": "2026-03-26T13:41:10+03:00",
                "operating_reset_at": 1774522270,
                "operating": 0
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
object | boolean

Результат запроса.

Если section не передан, result содержит объект, где ключами служат коды разделов, а значениями - объекты разделов (подробное описание).

Если section передан и найден, result содержит один объект раздела (подробное описание)

Если section передан, но такого раздела нет, метод вернет false без ошибки

time
time

Информация о времени выполнения запроса

Объект раздела

Название
тип

Описание

name
string

Название раздела

meta
object | array

Дополнительные данные раздела.

Например, раздел может вернуть служебные поля для AI-подсказок

new
boolean

Признак того, что в разделе есть новые блоки

type
string | array | null

Ограничение раздела по типу сайта, если оно задано.

Значение может быть массивом типов, строкой или null, если ограничение не задано. Для правил выбора типа сайта используйте статью Работа с типами сайтов и скоупами

specialType
string | null

Дополнительный тип раздела, если он задан.

Если дополнительный тип не задан, метод вернет null

separator
boolean

Признак служебного разделителя.

Разделы с таким флагом нужны для визуального разделения категорий в редакторе блоков. Они не содержат блоков, поэтому такие разделы можно пропускать при обходе ответа

app_code
string | boolean

Код приложения, если раздел относится к партнерскому каталогу, иначе false

items
object

Набор блоков раздела, где ключом служит код блока, а значением - объект блока (подробное описание).

Для избранных блоков ключ может содержать суффикс @<ID>

Особенности разделов:

  • last содержит блоки, которые пользователь недавно добавлял в редакторе. Раздел заполняется только в режиме редактирования. При обычном REST-вызове раздел обычно не возвращается,
  • favourite содержит избранные блоки и может возвращаться даже с пустым items,
  • пример разделителя: separator_apps,
  • состав полей раздела может отличаться. У разделов партнерских приложений могут отсутствовать meta, type и specialType.

Объект блока

Название
тип

Описание

id
string | null

Внутренний идентификатор блока из репозитория, если он задан.

Для части блоков метод вернет null

name
string

Название блока

namespace
string

Пространство имен блока

new
boolean

Признак нового блока

version
string | null

Минимальная версия продукта, для которой рассчитан блок, если она указана.

Если ограничение не задано, метод вернет null

type
array

Список типов сайтов, для которых доступен блок.

Пустой массив означает, что отдельное ограничение по типу сайта для блока не задано. Для правил выбора типа сайта используйте статью Работа с типами сайтов и скоупами

section
string | array

Код раздела или список кодов разделов, в которых показывается блок.

Обычно в ответе приходит массив кодов, например ["columns", "text"]. Эти коды можно использовать в параметре section при следующем вызове метода

system
boolean

Признак того, что блок является служебным и используется платформой внутри — не предназначен для добавления на страницу пользователем.

Такие блоки по умолчанию не включаются в ответ метода

description
string | null

Краткое описание блока.

Поле может быть пустой строкой или null

preview
string

Путь или URL изображения предпросмотра.

Для стандартных блоков может возвращаться URL без указания протокола вида //<домен>/..., для партнерских - абсолютный URL, а если изображения нет, поле может быть пустой строкой

restricted
boolean

Признак дополнительных ограничений блока

repo_id
integer | string | boolean

Идентификатор партнерского блока из репозитория приложений или false для стандартного блока

app_code
string | boolean

Код приложения, которому принадлежит блок, или false

only_for_license
string

Код лицензии, для которой доступен блок, если ограничение задано.

Если поле заполнено, значение соответствует текущей лицензии портала. Блоки для других лицензий в ответ не попадают

app_expired
boolean

Признак того, что срок действия приложения, которому принадлежит блок, истек.

Поле присутствует только у партнерских блоков с истекшей подпиской

requires_updates
boolean

Признак того, что для корректной работы блока нужна более новая версия продукта

favorite
boolean

Дополнительный флаг избранного блока

favoriteMy
boolean

Дополнительный флаг избранного блока, который показывает, что блок сохранен текущим пользователем

Состав полей блока может отличаться для стандартных, партнерских и избранных блоков. Метод возвращает только те поля, которые есть у конкретного блока.

Обработка ошибок

HTTP-статус: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "Недостаточно прав."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

ACCESS_DENIED

У пользователя нет доступа к разделу «Сайты и магазины»

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение