Get a List of Custom Blocks landing.repo.getList

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 View access permission in the Sites section

The method landing.repo.getList retrieves a list of custom blocks.

Method Parameters

Required parameters are marked with *

Name
type

Description

params
object

Object format:

{
            select: value_1,
            filter: value_2,
            order: value_3,
            group: value_4,
            limit: value_5,
            offset: value_6
        }

where:

value_n — value of the corresponding selection parameter

For more details on each parameter, see the params parameter section

params Parameter

Name `type`	Description
select `string[]`	Array format: `[ field_1, field_2, ..., field_n ]` where: `field_n` — selection field For a list of available fields for selection, see the result element type section. Elements in `select` with a `.` are ignored
filter `object`	Object format: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }` where: `field_n` — filtering field `value_n` — filter value For a list of available fields for filtering, see the result element type section. If `filter` is not provided or is not in the `object` format, the method uses an empty filter `{}`
order `object`	Object format: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }` where: `field_n` — sorting field `value_n` — sorting direction: `ASC` or `DESC` For a list of available fields for sorting, see the result element type section
group `array`	Array of fields for grouping the result. Format: `[ field_1, field_2, ..., field_n ]` where: `field_n` — grouping field Examples: `["ACTIVE"]` `["APP_CODE", "ACTIVE"]` For a list of available fields, see the result element type section
limit `integer`	Limit of records
offset `integer`	Offset of records

Note

If the method is called in the context of an application, the server additionally adds a filter for the current application.

In this case, only blocks created by the same application will be included in the response.

Code Examples

How to Use Examples in Documentation

Example of retrieving a list of blocks, where:

params.select — fields to return in the response
params.filter — conditions for filtering records
params.order — sorting the result
params.group — grouping fields

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": ["ID", "NAME", "DATE_MODIFY"],
              "filter": {"ACTIVE": "Y"},
              "order": {"ID": "DESC"},
              "group": ["ACTIVE"]
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.repo.getList.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": ["ID", "NAME", "DATE_MODIFY"],
              "filter": {"ACTIVE": "Y"},
              "order": {"ID": "DESC"},
              "group": ["ACTIVE"]
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.repo.getList.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.repo.getList',
        		{
        			params: {
        				select: ['ID', 'NAME', 'DATE_MODIFY'],
        				filter: { ACTIVE: 'Y' },
        				order: { ID: 'DESC' },
        				group: ['ACTIVE']
        			}
        		}
        	);
        
        	console.info(response.getData().result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.repo.getList',
                    [
                        'params' => [
                            'select' => ['ID', 'NAME', 'DATE_MODIFY'],
                            'filter' => ['ACTIVE' => 'Y'],
                            'order' => ['ID' => 'DESC'],
                            'group' => ['ACTIVE'],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting landing repository list: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.repo.getList',
            {
                params: {
                    select: ['ID', 'NAME', 'DATE_MODIFY'],
                    filter: { ACTIVE: 'Y' },
                    order: { ID: 'DESC' },
                    group: ['ACTIVE']
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.repo.getList',
            [
                'params' => [
                    'select' => ['ID', 'NAME', 'DATE_MODIFY'],
                    'filter' => ['ACTIVE' => 'Y'],
                    'order' => ['ID' => 'DESC'],
                    'group' => ['ACTIVE'],
                ],
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "ID": "5",
                    "XML_ID": "ctx_full_1774873150158",
                    "APP_CODE": "bitrix.restapi",
                    "ACTIVE": "Y",
                    "NAME": "Context full test block",
                    "DESCRIPTION": "Check full fields from getList",
                    "SECTIONS": "cover,about",
                    "SITE_TEMPLATE_ID": null,
                    "PREVIEW": "https://www.bitrix24.com/images/b24_screen.png",
                    "MANIFEST": {
                        "block": {
                            "name": "Context full test block"
                        },
                        "nodes": {
                            ".landing-block-node-text": {
                                "name": "Text",
                                "type": "text"
                            }
                        }
                    },
                    "CONTENT": "<section class=\"landing-block\"><div class=\"container\">Test</div></section>",
                    "CREATED_BY_ID": "577",
                    "MODIFIED_BY_ID": "577",
                    "DATE_CREATE": "30.03.2026 14:19:11",
                    "DATE_MODIFY": "30.03.2026 14:19:11"
                }
            ],
            "time": {
                "start": 1774873153,
                "finish": 1774873153.634216,
                "duration": 0.6342160701751709,
                "processing": 0,
                "date_start": "2026-03-30T15:19:13+02:00",
                "date_finish": "2026-03-30T15:19:13+02:00",
                "operating_reset_at": 1774873753,
                "operating": 0.11733078956604004
            }
        }

Returned Data

Name `type`	Description
result `object[]`	List of blocks more details
time `time`	Information about the request execution time

Result Element Type

Name `type`	Description
ID `string`	Identifier of the block
XML_ID `string`	External code of the block
APP_CODE `string` \| `null`	Application code
ACTIVE `string`	Activity status (`Y`/`N`)
NAME `string`	Name of the block
DESCRIPTION `string`	Description of the block
SECTIONS `string`	Sections of the block
SITE_TEMPLATE_ID `string` \| `null`	Identifier of the site template
PREVIEW `string`	Link to preview
MANIFEST `object` \| `array` \| `boolean`	Manifest of the block. For more details on the manifest structure: Manifest format description. Example of a manifest in the method response: landing.block.getManifestFile
CONTENT `string`	HTML of the block
CREATED_BY_ID `string`	Identifier of the author
MODIFIED_BY_ID `string`	Identifier of the user who modified the record
DATE_CREATE `string`	Creation date in the format `DD.MM.YYYY HH:MI:SS`
DATE_MODIFY `string`	Modification date in the format `DD.MM.YYYY HH:MI:SS`

Error Handling

HTTP Status: 400

{
            "error": "ERROR_ARGUMENT",
            "error_description": "The value of an argument 'params' has an invalid type",
            "argument": "params"
        }

{
            "error": "ACCESS_DENIED",
            "error_description": "Insufficient permissions."
        }

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	Value
`ACCESS_DENIED`	Insufficient permissions	User did not pass general access checks
`ERROR_ARGUMENT`	The value of an argument 'params' has an invalid type	The `params` argument was passed in an incorrect type
`SYSTEM_ERROR`	Internal error	Error executing the method on the server side
`insufficient_scope`	Insufficient scope for the token	The token does not contain the `landing` scope

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

Add Block to Repository

Remove Block from Repository

Get a List of Custom Blocks landing.repo.getList

Method ParametersMethod Parameters

params Parameterparams Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result Element TypeResult Element Type

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning