Получить список блоков страницы landing.block.getlist

Scope: landing

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

Метод landing.block.getlist возвращает список блоков выбранной страницы.

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

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

Название
тип

Описание

lid*
integer | integer[]

Идентификатор страницы или массив идентификаторов страниц.

Идентификаторы страниц можно получить методом landing.landing.getList

Если lid передан массивом, метод объединяет блоки всех указанных страниц в один список. В каждом элементе ответа есть поле lid, по которому можно определить страницу-источник.

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

params
object

Дополнительные параметры чтения списка (подробное описание)

Параметр params

Название
тип

Описание

edit_mode
boolean | integer

Если значение приводится к true, метод читает черновик страницы вместо опубликованной версии.

По умолчанию — false. Без этого параметра метод читает только опубликованные блоки

deleted
boolean | integer

Если значение приводится к true, метод возвращает только блоки, помеченные как удаленные.

По умолчанию — false. Параметр влияет только на выборку блоков. Поиск удаленной страницы он не включает, поэтому для страницы из корзины метод вернет ошибку.

Чтобы получить удаленные блоки, передайте deleted: true вместе с edit_mode: true. Параметр deleted сам по себе не переключает метод на черновик.

Если не указать edit_mode, метод будет искать блоки только в опубликованной версии страницы

get_content
boolean | integer

Если передать true, метод добавит в каждый элемент результата поля content, css и js. По умолчанию — false.

Поле content содержит уже подготовленный HTML блока вместе с системным контейнером блока, а не исходное сохраненное содержимое.

Если edit_mode выключен, метод вернет HTML опубликованной версии блока.
Если edit_mode включен, метод вернет HTML черновика

Примеры кода

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

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

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

HTTP-статус: 200

{
            "result": [
                {
                    "id": 28181,
                    "lid": 2215,
                    "code": "0.menu_02",
                    "name": "Меню с логотипом слева и пунктами меню справа",
                    "active": true,
                    "meta": {
                        "LID": "2215",
                        "FAVORITE_META": "Array",
                        "CREATED_BY_ID": "779",
                        "DATE_CREATE": "09/13/2024 10:28:08 am",
                        "MODIFIED_BY_ID": "1295",
                        "DATE_MODIFY": "03/26/2026 12:21:48 pm",
                        "SITE_TYPE": "PAGE",
                        "LANDING_TITLE": "",
                        "LANDING_TPL_CODE": "bitrix.krayt_otdykh_na_prirode",
                        "SITE_TPL_CODE": "empty",
                        "XML_ID": "",
                        "DESIGNER_MODE": ""
                    },
                    "content": "<div id=\"b2884\" class=\"block-wrapper block-0-menu-02\"><header class=\"landing-block u-header u-header--float u-header--sticky\">...</header></div>",
                    "css": [],
                    "js": []
                }
            ],
            "time": {
                "start": 1774521039,
                "finish": 1774521039.570632,
                "duration": 0.5706319808959961,
                "processing": 0,
                "date_start": "2026-03-26T13:30:39+03:00",
                "date_finish": "2026-03-26T13:30:39+03:00",
                "operating_reset_at": 1774521639,
                "operating": 0.48987889289855957
            }
        }
        

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

Название
тип

Описание

result
object[]

Список блоков (подробное описание).

Метод может вернуть result: [] без ошибки в трех случаях.

  • На странице нет блоков для выбранного режима чтения.
  • Страница еще не публиковалась и params.edit_mode не включен.
  • Фильтр deleted не нашел подходящих блоков

time
time

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

Объект block

Название
тип

Описание

id
integer

Идентификатор блока

lid
integer

Идентификатор страницы, к которой относится блок

code
string

Символьный код блока из библиотеки, например 0.menu_02

name
string

Название блока из его манифеста

active
boolean

Признак активности блока.

Активный блок отображается на странице. Неактивный блок скрыт

meta
object

Служебные данные блока и страницы (подробное описание).

Все значения внутри meta метод возвращает строками. Формат строковых дат зависит от языковых настроек Битрикс24

content
string

Подготовленный HTML блока. Поле возвращается только если включен params.get_content.

Если params.edit_mode = false, метод вернет HTML опубликованной версии блока.
Если params.edit_mode = true, метод вернет HTML черновика

css
string[]

Пути к CSS-файлам блока, которые нужны для его отображения.

Поле возвращается только если включен params.get_content. Если отдельных CSS-ресурсов нет, вернется пустой массив

js
string[]

Пути к JS-файлам блока, которые нужны для его работы.

Поле возвращается только если включен params.get_content. Если отдельных JS-ресурсов нет, вернется пустой массив

Объект meta

Название
тип

Описание

LID
string

Идентификатор страницы блока в строковом виде.

Дублирует верхнеуровневое поле lid

CREATED_BY_ID
string

Идентификатор пользователя, который создал блок

DATE_CREATE
string

Дата создания блока.

Формат зависит от языковых настроек портала

MODIFIED_BY_ID
string

Идентификатор пользователя, который последним изменил блок

DATE_MODIFY
string

Дата последнего изменения блока.

Формат зависит от языковых настроек портала

SITE_TYPE
string

Тип сайта, которому принадлежит страница, например PAGE или STORE

LANDING_TITLE
string

Название страницы, которой принадлежит блок.

Если название не заполнено, вернется пустая строка

LANDING_TPL_CODE
string

Код шаблона страницы

SITE_TPL_CODE
string

Код шаблона сайта

XML_ID
string

Внешний идентификатор блока.

Если он не задан, вернется пустая строка

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

HTTP-статус: 400

{
            "error": "LANDING_NOT_EXIST",
            "error_description": "Лендинг не найден"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

Не передан обязательный верхнеуровневый параметр lid

LANDING_NOT_EXIST

Страница не найдена, удалена или недоступна текущему пользователю

ACCESS_DENIED

У пользователя нет права на просмотр сайтов

TYPE_ERROR

Внутренняя ошибка несоответствия типов при вызове метода

SYSTEM_ERROR

Внутренняя ошибка при выполнении метода

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

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

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

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