Get the Manifest File of the Block landing.block.getmanifestfile

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: landing

Who can execute the method: a user with access to the "Sites and Stores" section

The method landing.block.getmanifestfile returns the original manifest of the block from the file repository.

Unlike landing.block.getmanifest, this method returns the manifest in its original form — as specified in the .description.php file. It does not add any service fields, such as code, preview, or timestamp.

Method Parameters

Required parameters are marked with *

Name
type

Description

code*
string

The code of the block from the file repository.

You can provide a short code, such as 01.big_with_text. In this case, the method will search for the block only in the bitrix namespace and will automatically add the prefix bitrix:.

If you need a block from a different namespace, provide the full code in the format <namespace>:<code>.

The code can only contain Latin letters, numbers, and the characters . _ - :

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "code": "01.big_with_text"
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getmanifestfile.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "code": "01.big_with_text",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.block.getmanifestfile.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.block.getmanifestfile',
        		{
        			code: '01.big_with_text'
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.block.getmanifestfile',
                    [
                        'code' => '01.big_with_text',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting block manifest file: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.block.getmanifestfile',
            {
                code: '01.big_with_text'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.block.getmanifestfile',
            [
                'code' => '01.big_with_text',
            ]
        );
        
        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": "Cover with Changing Background Images",
                    "section": [
                        "cover"
                    ],
                    "dynamic": false
                },
                "cards": {
                    ".landing-block-card-img": {
                        "name": "Background Image",
                        "label": [
                            ".landing-block-card-img"
                        ]
                    }
                },
                "nodes": {
                    ".landing-block-node-small-title": {
                        "name": "Subtitle",
                        "type": "text"
                    },
                    ".landing-block-node-title": {
                        "name": "Title",
                        "type": "text"
                    },
                    ".landing-block-node-text": {
                        "name": "Text",
                        "type": "text"
                    },
                    ".landing-block-node-button": {
                        "name": "Button",
                        "type": "link"
                    },
                    ".landing-block-card-img": {
                        "name": "Background Image",
                        "type": "img",
                        "dimensions": {
                            "width": 1920,
                            "height": 1080
                        },
                        "allowInlineEdit": false,
                        "useInDesigner": false,
                        "create2xByDefault": false
                    }
                },
                "style": {
                    "block": {
                        "type": [
                            "display"
                        ],
                        "additional": {
                            "name": "Slider",
                            "attrsType": [
                                "autoplay",
                                "autoplay-speed",
                                "pause-hover",
                                "dots"
                            ]
                        }
                    },
                    "nodes": {
                        ".landing-block-node-text-container": {
                            "title": "Set of Elements",
                            "type": [
                                "background-color",
                                "animation"
                            ]
                        },
                        ".landing-block-node-small-title": {
                            "title": "Subtitle",
                            "type": [
                                "typo",
                                "heading"
                            ]
                        },
                        ".landing-block-node-title": {
                            "title": "Title",
                            "type": [
                                "typo",
                                "heading"
                            ]
                        },
                        ".landing-block-node-text": {
                            "title": "Text",
                            "type": "typo"
                        },
                        ".landing-block-node-button": {
                            "title": "Button",
                            "type": "button"
                        },
                        ".landing-block-card-img": {
                            "name": "Background Image",
                            "type": [
                                "background-overlay",
                                "height-vh"
                            ]
                        }
                    }
                },
                "assets": {
                    "ext": [
                        "landing_carousel"
                    ]
                }
            },
            "time": {
                "start": 1774521452,
                "finish": 1774521452.955493,
                "duration": 0.9554929733276367,
                "processing": 0,
                "date_start": "2026-03-26T13:37:32+02:00",
                "date_finish": "2026-03-26T13:37:32+02:00",
                "operating_reset_at": 1774522052,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object | array

The original manifest of the block from the file repository.

The general format of the manifest file is described in the article Manifest File.

If the block is not found, the code contains invalid characters, or a local repository block code of the form repo_<ID> is provided, the method will return an empty array [] without an error

time
time

Information about the execution time of the request

Object result

Name
type

Description

block
object

Description of the block from the block section of the manifest file. Usually contains fields: name, section, dynamic, type, system, description, version, id, only_for_license

cards
object | array

Description of the block cards, if any

nodes
object | array

Description of the editable nodes of the block

style
object | array

Description of the available style settings of the block as declared in the manifest

attrs
object | array

Description of the customizable attributes of the block, if specified

assets
object

Resources explicitly declared in the block manifest.

For example, the response may include assets.ext if extensions are declared directly in .description.php

menu
object | array

Description of the block menu, if any

The result may contain other keys. Their composition depends on the specific block and the contents of the manifest.

In nested objects, such as nodes, cards, and style.nodes, the set of fields also depends on the specific block. The method returns this data in its original form, so one block may use the field title, while another uses name.

Localizable names and labels are returned in the portal's language if they are specified in the manifest through language files.

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Not enough call parameters, missing: code"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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

MISSING_PARAMS

The required parameter code is missing

ACCESS_DENIED

Access denied: the user does not have access to the "Sites and Stores" section

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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