Get a List of Blocks from the Repository landing.block.getrepository

{% note tip "" %}

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.

{% endnote %}

Scope: landing

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

The method landing.block.getrepository returns the available sections of the block repository or the data for a specific section.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || section string | The code of the repository section, for example text.

If the parameter is not provided, the method will return all available sections. In this case, the keys of the result object will be the section codes.

In addition to standard sections, the response may include sections from partner applications and system sections. To get the current section codes, call the method without section.

If a section with the specified code is not found or an empty string is provided, the method will return false without an error || || scope string | An additional top-level parameter of the REST call that affects the type of site for which the repository is being collected.

For site types PAGE, STORE, and SMN, this parameter does not need to be provided. For GROUP, KNOWLEDGE, and MAINPAGE, provide the corresponding scope.

The rules for selecting the value are described in detail in the article Working with Site Types and Scopes.

If scope is not provided, the method uses the current site type, and if it cannot be determined from the context, it operates as if for the PAGE type || |#

Code Examples

{% include Note on Examples %}

{% list tabs %}

cURL (Webhook)

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "section": "text"
  }' \
  "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getrepository.json"

cURL (OAuth)

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "section": "text",
    "auth": "**put_access_token_here**"
  }' \
  "https://**put.your-domain-here**/rest/landing.block.getrepository.json"

JS (TS)

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type BlockItem = {
  id: string | null
  name: string
  namespace: string
  new: boolean
  version: string | null
  type: string[]
  section: string | string[]
  description: string | null
  preview: string
  restricted: boolean
  repo_id: number | string | boolean
  app_code: string | boolean
  requires_updates: boolean
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type RepositorySection = {
  name: string
  meta: Record<string, unknown> | unknown[]
  new: boolean
  type: string | string[] | null
  specialType: string | null
  separator: boolean
  app_code: string | boolean
  items: Record<string, BlockItem>
}

try {
  const response = await $b24.actions.v2.call.make<RepositorySection | false>({
    method: 'landing.block.getrepository',
    params: {
      section: 'text',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    if (result !== false) {
      console.info('Section name:', result.name, 'Blocks count:', Object.keys(result.items).length)
    }
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

JS (UMD)

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getRepository() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'landing.block.getrepository',
        params: {
          section: 'text',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      if (result !== false) {
        console.info('Section name:', result.name, 'Blocks count:', Object.keys(result.items).length)
      }
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getRepository)
</script>

Python

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.landing.block.getrepository(
        section="text",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Bitrix API error",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Bitrix SDK error: {error.message}")
except Exception as error:
    print(f"Unexpected error: {error}")

PHP

try {
    $response = $b24Service
        ->core
        ->call(
            'landing.block.getrepository',
            [
                'section' => 'text',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . var_export($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting repository blocks: ' . $e->getMessage();
}

BX24.js

BX24.callMethod(
    'landing.block.getrepository',
    {
        section: 'text'
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);

PHP CRest

require_once('crest.php');

$result = CRest::call(
    'landing.block.getrepository',
    [
        'section' => 'text',
    ]
);

if (isset($result['error']))
{
    echo 'Error: ' . $result['error_description'];
}
else
{
    echo '<pre>';
    print_r($result['result']);
    echo '</pre>';
}

// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.block.getrepository", b24.Params{
	"section": "text",
})
if err != nil {
	return fmt.Errorf("landing.block.getrepository: %w", err)
}

var item struct {
	Name      string `json:"name"`
	New       bool   `json:"new"`
	Separator bool   `json:"separator"`
	AppCode   bool   `json:"app_code"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Name, item.New)

{% endlist %}

Response Handling

HTTP Status: 200

Example Response for Request with Section Parameter

{
    "result": {
        "name": "Text",
        "meta": {
            "ai_text_placeholder": "text for website, family business, sale of flowers",
            "ai_text_max_tokens": 150
        },
        "new": false,
        "type": null,
        "specialType": null,
        "separator": false,
        "app_code": false,
        "items": {
            "03.1.three_cols_big_with_text_and_titles": {
                "id": null,
                "name": "Text in 3 Columns Full Width on Color Background",
                "namespace": "bitrix",
                "new": false,
                "version": null,
                "type": [],
                "section": [
                    "columns",
                    "text"
                ],
                "system": false,
                "description": "Three columns with headings and text",
                "preview": "//example.bitrix24.com/bitrix/blocks/bitrix/03.1.three_cols_big_with_text_and_titles/preview.jpg",
                "restricted": false,
                "repo_id": false,
                "app_code": false,
                "only_for_license": "",
                "requires_updates": false
            },
            "repo_405": {
                "id": null,
                "new": false,
                "name": "Block 'Text + Image' with Button, Text on the Right, Image on the Left",
                "description": null,
                "namespace": "krayt.monotovar",
                "type": [],
                "section": [
                    "about",
                    "text",
                    "image"
                ],
                "preview": "https://example.com/upload/iblock/5aa/5aabf5b9241876561d5db49c482dcd96.png",
                "restricted": true,
                "repo_id": "405",
                "app_code": "krayt.monotovar",
                "requires_updates": false
            }
        }
    },
    "time": {
        "start": 1774521670,
        "finish": 1774521670.823288,
        "duration": 0.8232879638671875,
        "processing": 0,
        "date_start": "2026-03-26T13:41:10+02:00",
        "date_finish": "2026-03-26T13:41:10+02:00",
        "operating_reset_at": 1774522270,
        "operating": 0
    }
}

Example Response for Request without Section Parameter

{
    "result": {
        "favourite": {
            "name": "Favorites",
            "meta": [],
            "new": false,
            "type": null,
            "specialType": null,
            "separator": false,
            "app_code": false,
            "items": {}
        },
        "text": {
            "name": "Text",
            "meta": {
                "ai_text_placeholder": "text for website, family business, sale of flowers",
                "ai_text_max_tokens": 150
            },
            "new": false,
            "type": null,
            "specialType": null,
            "separator": false,
            "app_code": false,
            "items": {
                "03.1.three_cols_big_with_text_and_titles": {
                    "id": null,
                    "name": "Text in 3 Columns Full Width on Color Background",
                    "namespace": "bitrix",
                    "new": false,
                    "version": null,
                    "type": [],
                    "section": [
                        "columns",
                        "text"
                    ],
                    "system": false,
                    "description": "Three columns with headings and text",
                    "preview": "//example.bitrix24.com/bitrix/blocks/bitrix/03.1.three_cols_big_with_text_and_titles/preview.jpg",
                    "restricted": false,
                    "repo_id": false,
                    "app_code": false,
                    "only_for_license": "",
                    "requires_updates": false
                }
            }
        }
    },
    "time": {
        "start": 1774521670,
        "finish": 1774521670.823288,
        "duration": 0.8232879638671875,
        "processing": 0,
        "date_start": "2026-03-26T13:41:10+02:00",
        "date_finish": "2026-03-26T13:41:10+02:00",
        "operating_reset_at": 1774522270,
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result object | boolean | The result of the request.

If section is not provided, result contains an object where the keys are the section codes and the values are the section objects (detailed description).

If section is provided and found, result contains a single section object (detailed description).

If section is provided but such a section does not exist, the method will return false without an error || || time time | Information about the execution time of the request || |#

Section Object {#repository-section}

#| || Name type | Description || || name string | The name of the section || || meta object | array | Additional data for the section.

For example, the section may return service fields for AI prompts || || new boolean | Indicates whether there are new blocks in the section || || type string | array | null | Restriction of the section by site type, if specified.

The value can be an array of types, a string, or null if no restriction is specified. For rules on selecting the site type, refer to the article Working with Site Types and Scopes || || specialType string | null | Additional type of the section, if specified.

If no additional type is specified, the method will return null || || separator boolean | Indicates a service separator.

Sections with this flag are needed for visually separating categories in the block editor. They do not contain blocks, so such sections can be skipped when traversing the response || || app_code string | boolean | The application code if the section belongs to the partner catalog, otherwise false || || items object | A set of blocks in the section, where the key is the block code and the value is the block object (detailed description).

For favorite blocks, the key may contain the suffix @<ID> || |#

Section Features:

last contains blocks that the user recently added in the editor. This section is filled only in edit mode. In a regular REST call, this section is usually not returned,
favourite contains favorite blocks and may be returned even with an empty items,
example of a separator: separator_apps,
the composition of the section fields may vary. Sections from partner applications may lack meta, type, and specialType.

Block Object {#repository-block}

#| || Name type | Description || || id string | null | Internal identifier of the block from the repository, if specified.

For some blocks, the method will return null || || name string | The name of the block || || namespace string | The namespace of the block || || new boolean | Indicates whether the block is new || || version string | null | Minimum version of the product for which the block is designed, if specified.

If no restriction is specified, the method will return null || || type array | List of site types for which the block is available.

An empty array means that no specific restriction by site type is set for the block. For rules on selecting the site type, refer to the article Working with Site Types and Scopes || || section string | array | The code of the section or a list of section codes in which the block is displayed.

Usually, an array of codes is returned in the response, for example ["columns", "text"]. These codes can be used in the section parameter in the next method call || || system boolean | Indicates whether the block is a system block used internally by the platform — not intended for user addition to the page.

Such blocks are not included in the method's response by default || || description string | null | A brief description of the block.

The field may be an empty string or null || || preview string | The path or URL of the preview image.

For standard blocks, a URL without specifying the protocol may be returned, such as //<domain>/..., for partner blocks - an absolute URL, and if there is no image, the field may be an empty string || || restricted boolean | Indicates additional restrictions on the block || || repo_id integer | string | boolean | Identifier of the partner block from the application repository or false for a standard block || || app_code string | boolean | The application code to which the block belongs, or false || || only_for_license string | The license code for which the block is available, if specified.

If the field is filled, the value corresponds to the current license of the account. Blocks for other licenses do not appear in the response || || app_expired boolean | Indicates whether the subscription for the application to which the block belongs has expired.

This field is present only for partner blocks with an expired subscription || || requires_updates boolean | Indicates whether a newer version of the product is required for the block to function correctly || || favorite boolean | Additional flag for favorite blocks || || favoriteMy boolean | Additional flag for favorite blocks indicating that the block is saved by the current user || |#

The composition of the block fields may vary for standard, partner, and favorite blocks. The method returns only those fields that are present for a specific block.

Error Handling

HTTP Status: 400

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

{% include notitle error handling %}

Possible Error Codes

#| || Code | Description || || ACCESS_DENIED | The user does not have access to the "Sites and Stores" section || |#

{% include system errors %}

Navigation Menu

Uh oh!

Get a List of Blocks from the Repository landing.block.getrepository

Method Parameters

Code Examples

Response Handling

Example Response for Request with Section Parameter

Example Response for Request without Section Parameter

Returned Data

Section Object {#repository-section}

Block Object {#repository-block}

Error Handling

Possible Error Codes

Continue Learning

Uh oh!

FilesExpand file tree

landing-block-get-repository.md

Latest commit

History

landing-block-get-repository.md

File metadata and controls

Get a List of Blocks from the Repository landing.block.getrepository

Method Parameters

Code Examples

Response Handling

Example Response for Request with Section Parameter

Example Response for Request without Section Parameter

Returned Data

Section Object {#repository-section}

Block Object {#repository-block}

Error Handling

Possible Error Codes

Continue Learning