Получить список зарегистрированных шаблонов landing.demos.getList

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: landing

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

Метод landing.demos.getList получает список зарегистрированных шаблонов.

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

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

Название
тип

Описание

params
object

Объект формата:

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

где:

  • value_n — значение соответствующего параметра выборки

Подробнее о каждом параметре смотрите в разделе Параметр params

Параметр params

Название
тип

Описание

select
string[]

Массив формата:

[
            field_1,
            field_2,
            ...,
            field_n
        ]
        

где:

  • field_n — поле выборки

Список доступных полей для выборки смотрите в разделе Тип элемента result.

Элементы select со знаком . игнорируются

filter
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }
        

где:

  • field_n — поле фильтрации
  • value_n — значение фильтра

Список доступных полей для фильтрации смотрите в разделе Тип элемента result.

Если filter не передан или передан не в формате object, метод использует пустой фильтр {}

order
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }
        

где:

  • field_n — поле сортировки
  • value_n — направление сортировки: ASC или DESC

Список доступных полей для сортировки смотрите в разделе Тип элемента result

group
array

Массив полей для группировки результата.

Формат:

[
            field_1,
            field_2,
            ...,
            field_n
        ]
        

где:

  • field_n — поле группировки

Примеры:

  • ["TYPE"]
  • ["ACTIVE", "TYPE"]

Список доступных полей смотрите в разделе Тип элемента result

limit
integer

Лимит записей в выборке

offset
integer

Смещение записей в выборке

Примечание

Если метод вызван в контексте приложения, сервер дополнительно добавляет фильтр текущего приложения.

В этом случае в ответ попадут только шаблоны, созданные этим же приложением.

При вызове не из контекста приложения этот фильтр не добавляется.

Примеры кода

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

Пример получения списка шаблонов, где:

  • params.select — поля, которые нужно вернуть в ответе
  • params.filter — условия фильтрации записей
  • params.order — сортировка результата
  • params.group — поля группировки
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": ["ID", "XML_ID", "TITLE", "TYPE", "DATE_MODIFY"],
              "filter": {"ACTIVE": "Y"},
              "order": {"ID": "DESC"},
              "group": ["TYPE"]
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.demos.getList.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": ["ID", "XML_ID", "TITLE", "TYPE", "DATE_MODIFY"],
              "filter": {"ACTIVE": "Y"},
              "order": {"ID": "DESC"},
              "group": ["TYPE"]
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.demos.getList.json"
        
// 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
        
        // Shape of each DemoItem returned in result[]
        type DemoItem = {
          ID: string
          XML_ID: string
          TITLE: string
          TYPE: string
          DATE_MODIFY: string
          MANIFEST: object | boolean
        }
        
        try {
          // landing.demos.getList returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<DemoItem[]>({
            method: 'landing.demos.getList',
            params: {
              params: {
                select: ['ID', 'XML_ID', 'TITLE', 'TYPE', 'DATE_MODIFY'],
                filter: { ACTIVE: 'Y' },
                order: { ID: 'DESC' },
                group: ['TYPE'],
              },
              start: 0,
            },
            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
            console.info('Demo templates:', result.length, result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- 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 getDemoList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.demos.getList',
                params: {
                  params: {
                    select: ['ID', 'XML_ID', 'TITLE', 'TYPE', 'DATE_MODIFY'],
                    filter: { ACTIVE: 'Y' },
                    order: { ID: 'DESC' },
                    group: ['TYPE'],
                  },
                  start: 0,
                },
                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
              console.info('Demo templates:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDemoList)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.demos.getList',
                    [
                        'params' => [
                            'select' => ['ID', 'XML_ID', 'TITLE', 'TYPE', 'DATE_MODIFY'],
                            'filter' => ['ACTIVE' => 'Y'],
                            'order' => ['ID' => 'DESC'],
                            'group' => ['TYPE'],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting demo list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.demos.getList',
            {
                params: {
                    select: ['ID', 'XML_ID', 'TITLE', 'TYPE', 'DATE_MODIFY'],
                    filter: { ACTIVE: 'Y' },
                    order: { ID: 'DESC' },
                    group: ['TYPE']
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.demos.getList',
            [
                'params' => [
                    'select' => ['ID', 'XML_ID', 'TITLE', 'TYPE', 'DATE_MODIFY'],
                    'filter' => ['ACTIVE' => 'Y'],
                    'order' => ['ID' => 'DESC'],
                    'group' => ['TYPE'],
                ],
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "landing.demos.getList", b24.Params{
        	"params": b24.Params{
        		"select": []string{"ID", "XML_ID", "TITLE", "TYPE", "DATE_MODIFY"},
        		"filter": b24.Params{
        			"ACTIVE": "Y",
        		},
        		"order": b24.Params{
        			"ID": "DESC",
        		},
        		"group": []string{"TYPE"},
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("landing.demos.getList: %w", err)
        }
        
        var items []struct {
        	ID         b24.ID `json:"ID"`
        	XMLID      string `json:"XML_ID"`
        	Title      string `json:"TITLE"`
        	Type       string `json:"TYPE"`
        	DateModify string `json:"DATE_MODIFY"`
        	Manifest   bool   `json:"MANIFEST"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("разбор ответа: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.XMLID)
        }
        

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "9",
                    "XML_ID": "ftmlt/biznes",
                    "TITLE": "Бизнес",
                    "TYPE": "page",
                    "DATE_MODIFY": "27.03.2026 14:18:15",
                    "MANIFEST": false
                }
            ],
            "time": {
                "start": 1774621455,
                "finish": 1774621455.226454,
                "duration": 0.2264540195465088,
                "processing": 0,
                "date_start": "2026-03-27T17:24:15+03:00",
                "date_finish": "2026-03-27T17:24:15+03:00",
                "operating_reset_at": 1774622055,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
object[]

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

Если подходящих записей нет, метод возвращает result: []

time
time

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

Тип элемента result

Название
тип

Описание

ID
integer | string

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

XML_ID
string

Внешний код шаблона

APP_CODE
string

Код приложения

ACTIVE
string

Признак активности (Y/N)

TITLE
string

Название шаблона

DESCRIPTION
string | null

Описание шаблона

TYPE
string

Тип шаблона.

Возможные значения:

  • page — шаблоны для страниц/сайтов
  • store — шаблоны для магазинов
  • knowledge — шаблоны для баз знаний
  • group — шаблоны для групп
  • mainpage — шаблоны для главных страниц

TPL_TYPE
string

Тип мастера.

Возможные значения:

  • S — шаблон сайта
  • P — шаблон страницы

SHOW_IN_LIST
string

Признак показа в списке (Y/N)

PREVIEW_URL
string

Ссылка на предпросмотр

PREVIEW
string

Preview 1x

PREVIEW2X
string

Preview 2x

PREVIEW3X
string

Preview 3x

MANIFEST
object | boolean

Манифест шаблона.

В исходных данных хранится сериализованно, в ответе метода возвращается как объект после unserialize.

Если манифест не задан, может возвращаться false

LANG
object | null

Локализация шаблона.

Если поле заполнено, в ответе возвращается после unserialize.

Состав и ключи локализации зависят от шаблона. Подробнее: Локализация шаблона

SITE_TEMPLATE_ID
string | null

Идентификатор шаблона сайта главного модуля

CREATED_BY_ID
integer

Идентификатор пользователя, создавшего шаблон

MODIFIED_BY_ID
integer

Идентификатор пользователя, изменившего шаблон

DATE_CREATE
string

Дата создания.

Метод приводит значение к строке

DATE_MODIFY
string

Дата изменения.

Метод приводит значение к строке

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

ERROR_ARGUMENT

The value of an argument 'params' has an invalid type

Параметр params передан в неверном типе

ACCESS_DENIED

Недостаточно прав

Пользователь не прошел общие проверки доступа

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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