Get the Manifest of the landing.block.getmanifest Method
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
landingWho can execute the method: a user with "view" access permission for pages
The landing.block.getmanifest method returns a prepared manifest of the block placed on the page.
It does not return the original file but rather the prepared data for a specific block. For example, localized titles, fields such as code, preview, assets, timestamp, and callbacks.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
scope |
Internal scope of the landing. It is not related to the REST scope The value of |
|
lid* |
Page identifier. The page identifier can be obtained using the landing.landing.getlist method |
|
block* |
Block identifier. The block must belong to the page The block identifier can be obtained using the landing.block.getlist method |
|
params |
Additional parameters for reading the manifest (detailed description) |
Parameter params
|
Name |
Description |
|
If the value is cast to Without this parameter, the method searches for the block only in the published version of the page. |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"lid": 4858,
"block": 39556,
"params": {
"edit_mode": true
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getmanifest.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"lid": 4858,
"block": 39556,
"params": {
"edit_mode": true
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.block.getmanifest.json"
try
{
const response = await $b24.callMethod(
'landing.block.getmanifest',
{
lid: 4858,
block: 39556,
params: {
edit_mode: true
}
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.block.getmanifest',
[
'lid' => 4858,
'block' => 39556,
'params' => [
'edit_mode' => true,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . var_export($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting block manifest: ' . $e->getMessage();
}
BX24.callMethod(
'landing.block.getmanifest',
{
lid: 4858,
block: 39556,
params: {
edit_mode: true
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.block.getmanifest',
[
'lid' => 4858,
'block' => 39556,
'params' => [
'edit_mode' => true,
],
]
);
if (isset($result['error']))
{
echo 'Error: ' . $result['error_description'];
}
else
{
echo '<pre>';
print_r($result['result']);
echo '</pre>';
}
Response Handling
HTTP Status: 200
{
"result": {
"block": {
"name": "Form on a light background in the center",
"section": [
"forms"
],
"dynamic": false,
"subtype": "form",
"attrsFormDescription": "<a href=\"/crm/webform/\" target=\"_blank\">Configure CRM forms</a>"
},
"nodes": {
"#wrapper": {
"type": "styleimg",
"code": "#wrapper"
}
},
"style": {
"block": {
"type": [
"block-default",
"block-border"
]
},
"nodes": {
".bitrix24forms": {
"type": "crm-form"
}
}
},
"assets": {
"css": [],
"js": [],
"ext": [
"landing_form"
],
"class": [],
"callbacks": []
},
"timestamp": 1751467642,
"callbacks": {
"afteradd": {}
},
"attrs": {
".bitrix24forms": [
{
"name": "Embed form flag",
"attribute": "data-b24form-embed",
"type": "string",
"hidden": true
},
{
"name": "Form design",
"attribute": "data-b24form-design",
"type": "string",
"hidden": true
},
{
"name": "Form from connector flag",
"attribute": "data-b24form-connector",
"type": "string",
"hidden": true
},
{
"name": "CRM form",
"attribute": "data-b24form",
"items": [
{
"name": "Feedback form",
"value": "#crmFormInline3"
},
{
"name": "Contact details with comment",
"value": "#crmFormInline39"
}
],
"type": "list"
},
{
"name": "Form design",
"attribute": "data-b24form-use-style",
"type": "list",
"items": [
{
"name": "Use block design",
"value": "Y"
},
{
"name": "Use CRM form design",
"value": "N"
}
]
}
]
},
"cards": [],
"menu": [],
"namespace": "bitrix",
"code": "33.13.form_2_light_no_text",
"preview": "/bitrix/blocks/bitrix/33.13.form_2_light_no_text/preview.jpg"
},
"time": {
"start": 1774521323,
"finish": 1774521323.212432,
"duration": 0.2124319076538086,
"processing": 0,
"date_start": "2026-03-26T13:35:23+01:00",
"date_finish": "2026-03-26T13:35:23+01:00",
"operating_reset_at": 1774521923,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The prepared manifest of the block (detailed description). The general format of the manifest is described in the article Manifest File. Empty sections of the manifest may return as empty arrays |
|
time |
Information about the execution time of the request |
Object result
|
Name |
Description |
|
block |
Main properties of the block from the manifest (detailed description) |
|
cards |
Description of the block cards, if any. If there are no cards, it may return an empty array |
|
nodes |
Description of the editable nodes of the block. For each node, the method additionally adds a For nodes with a separate handler in the editor, the method also adds a |
|
attrs |
Description of customizable attributes of the block, if any. If there are no attributes, it may return an empty array |
|
menu |
Description of the block menu, if any. If there is no menu, it may return an empty array |
|
style |
Description of available style settings for the block. If the original manifest does not separate styles into |
|
namespace |
Namespace of the block. For built-in blocks in Bitrix24, this is usually |
|
code |
Block code |
|
preview |
Relative path to the preview file If the preview file is missing, an empty string will be returned. For blocks registered via REST API or applications, this field returns an empty string |
|
assets |
Block resources (detailed description) |
|
timestamp |
Time of the base manifest update in Unix Timestamp format. For a local block, this is the time of the file |
|
callbacks |
Callback handlers from the block manifest. The names of the handlers are converted to lowercase by the method |
The result may contain other keys from the original manifest. Their composition depends on the specific block.
Object block
|
Name |
Description |
|
name |
Name of the block |
|
section |
Sections to which the block belongs |
|
dynamic |
Indicator of a dynamic block |
|
Subtype of the block, if specified |
In the block object, there may be other fields of the manifest. Their set depends on the specific block.
Object assets
|
Name |
Description |
|
css |
List of CSS resources for the block. This includes paths from the manifest and any automatically found local For design local blocks, |
|
js |
List of JS resources for the block. This includes paths from the manifest and any automatically found local |
|
ext |
List of client extensions for the block. For REST blocks, the method returns only extensions from the allowed list |
|
class |
Service paths to PHP classes of the block on the server. For most regular calls, this array is empty or not needed for client code |
|
callbacks |
List of callback functions from the Unlike |
Error Handling
HTTP Status: 400
{
"error": "BLOCK_NOT_FOUND",
"error_description": "Block not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Required parameter |
|
|
User does not have permission to view the page |
|
|
Page with identifier |
|
|
Block with identifier |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Get Content of Block `landing.block.getcontent`
- Get the List of Page Blocks `landing.block.getlist`
- Get Block by ID `landing.block.getbyid`
- Get the Manifest File of the Block landing.block.getmanifestfile