Получить блок по идентификатору landing.block.getbyid

Scope: landing

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

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

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

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

Название
тип

Описание

block*
integer

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

Идентификатор блока можно получить методом landing.block.getlist

params
object

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

Параметр params

Название
тип

Описание

edit_mode
boolean | integer

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

По умолчанию — false

deleted
boolean | integer

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

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

get_content
boolean | integer

Если значение приводится к true, в result дополнительно возвращаются поля content, css и js.

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

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "block": 39556,
            "params": {
              "edit_mode": true,
              "get_content": true
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getbyid.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "block": 39556,
            "params": {
              "edit_mode": true,
              "get_content": true
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.block.getbyid.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.block.getbyid',
        		{
        			block: 39556,
        			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.getbyid',
                    [
                        'block' => 39556,
                        '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 by ID: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.block.getbyid',
            {
                block: 39556,
                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.getbyid',
            [
                'block' => 39556,
                '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": 39556,
                "lid": 4858,
                "code": "01.big_with_text",
                "name": "Блок с текстом и изображением",
                "active": true,
                "meta": {
                    "LID": "2215",
                    "FAVORITE_META": "Array",
                    "CREATED_BY_ID": "1295",
                    "DATE_CREATE": "03/26/2026 11:27:24 am",
                    "MODIFIED_BY_ID": "1295",
                    "DATE_MODIFY": "03/26/2026 12:23:02 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=\"b28853\" class=\"block-wrapper block-18-2-two-cols-fix-img-text-button-with-cards\"><section class=\"landing-block g-pt-30 g-pb-30 g-bg-transparent\">...</section></div>",
                "css": [],
                "js": []
            },
            "time": {
                "start": 1774521156,
                "finish": 1774521157.330784,
                "duration": 1.3307840824127197,
                "processing": 1,
                "date_start": "2026-03-26T13:32:36+03:00",
                "date_finish": "2026-03-26T13:32:37+03:00",
                "operating_reset_at": 1774521756,
                "operating": 0.3684520721435547
            }
        }

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

Название
тип

Описание

result
object

Данные найденного блока (подробное описание)

Метод не возвращает result: []. Если блок не найден в выбранной версии страницы, метод завершается ошибкой

time
time

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

Объект result

Название
тип

Описание

id
integer

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

lid
integer

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

code
string

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

name
string

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

active
boolean

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

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

meta
object

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

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

content
string

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

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

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

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

DESIGNER_MODE
string

Служебное поле режима дизайнера.

В методе landing.block.getbyid возвращается пустой строкой

FAVORITE_META
string

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

Если таких данных нет, вернется пустая строка. Если данные есть, в этом методе значение может прийти как строка "Array"

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

HTTP-статус: 400

{
            "error": "BLOCK_NOT_FOUND",
            "error_description": "Блок не найден"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

Недостаточно параметров вызова, пропущены: block

ACCESS_DENIED

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

BLOCK_NOT_FOUND

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

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

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

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

Предыдущая
Получить список блоков страницы
Следующая
Получить манифест блока