Получить список шаблонов для создания сайтов landing.demos.getSiteList

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

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

Scope: landing

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

Метод landing.demos.getSiteList получает список файловых демо-шаблонов сайтов.

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

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

Название
тип

Описание

type*
string

Тип шаблона.

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

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

filter
object

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

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

где:

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

Фильтрация применяется к полям верхнего уровня объекта шаблона.

Фильтровать можно по полям из раздела Тип шаблона сайта. Вложенные поля (например, DATA.*) в фильтре не учитываются

Примеры кода

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

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

  • type — код набора шаблонов
  • filter — фильтр по полям шаблона сайта
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "type": "page",
    "filter": {
      "TYPE": "page"
    }
  }' \
  "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.demos.getSiteList.json"

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "type": "page",
    "filter": {
      "TYPE": "page"
    },
    "auth": "**put_access_token_here**"
  }' \
  "https://**put.your-domain-here**/rest/landing.demos.getSiteList.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 the payload returned in result (match the "response handling" section of the page)
type SiteListResult = Record<string, SiteTemplate>

type SiteTemplate = {
  ID: string,
  XML_ID: string,
  TYPE: string[] | string,
  TITLE: string,
  ACTIVE: boolean,
  PUBLICATION: boolean,
  LOCK_DELETE: boolean,
  AVAILABLE: boolean,
  SINGLETON: boolean,
  SECTION: string[],
  DESCRIPTION: string,
  PREVIEW: string,
  PREVIEW2X: string,
  PREVIEW3X: string,
  APP_CODE: string,
  REST: number,
  DATA: Record<string, unknown>,
}

try {
  const response = await $b24.actions.v2.call.make<SiteListResult>({
    method: 'landing.demos.getSiteList',
    params: {
      type: 'page',
      filter: {
        TYPE: 'page',
      },
    },
    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('Site demo templates:', Object.keys(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 fetchSiteList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'landing.demos.getSiteList',
        params: {
          type: 'page',
          filter: {
            TYPE: 'page',
          },
        },
        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('Site demo templates:', Object.keys(result))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.landing.demos.get_site_list(
        type="page",
        filter={
            "TYPE": "page",
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'landing.demos.getSiteList',
            [
                'type' => 'page',
                'filter' => [
                    'TYPE' => 'page',
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting site demo list: ' . $e->getMessage();
}

BX24.callMethod(
    'landing.demos.getSiteList',
    {
        type: 'page',
        filter: {
            TYPE: 'page'
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'landing.demos.getSiteList',
    [
        'type' => 'page',
        'filter' => [
            'TYPE' => 'page',
        ],
    ]
);

echo '<pre>';
print_r($result);
echo '</pre>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.demos.getSiteList", b24.Params{
	"type": "page",
	"filter": b24.Params{
		"TYPE": "page",
	},
})
if err != nil {
	return fmt.Errorf("landing.demos.getSiteList: %w", err)
}

// Метод заворачивает ответ в объект с ключом "empty".
raw, ok := b24.Unwrap(res.Result, "empty")
if !ok {
	return fmt.Errorf("в ответе нет ключа empty")
}

var item struct {
	ID          string `json:"ID"`
	XMLID       string `json:"XML_ID"`
	Title       string `json:"TITLE"`
	Active      bool   `json:"ACTIVE"`
	Publication bool   `json:"PUBLICATION"`
	LockDelete  bool   `json:"LOCK_DELETE"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.XMLID)

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

HTTP-статус: 200

{
    "result": {
        "empty": {
            "ID": "empty",
            "XML_ID": "empty",
            "TYPE": ["KNOWLEDGE", "GROUP", "PAGE", "MAINPAGE"],
            "TITLE": "Пустой шаблон",
            "ACTIVE": true,
            "PUBLICATION": false,
            "LOCK_DELETE": false,
            "AVAILABLE": true,
            "SINGLETON": false,
            "SECTION": [],
            "DESCRIPTION": "Создайте собственный сайт с чистого листа и привлекайте клиентов!",
            "PREVIEW": "//bitrix24.ru/bitrix/components/bitrix/landing.demo/data/site/empty/preview.jpg",
            "PREVIEW2X": "//bitrix24.ru/bitrix/components/bitrix/landing.demo/data/site/empty/preview@2x.jpg",
            "PREVIEW3X": "//bitrix24.ru/bitrix/components/bitrix/landing.demo/data/site/empty/preview@3x.jpg",
            "APP_CODE": "",
            "REST": 0,
            "DATA": {
                "name": "Пустой шаблон",
                "items": [],
                "encoded": true,
                "charset": "UTF-8"
            }
        }
    },
    "time": {
        "start": 1774623040,
        "finish": 1774623040.337361,
        "duration": 0.33736109733581543,
        "processing": 0,
        "date_start": "2026-03-27T17:50:40+03:00",
        "date_finish": "2026-03-27T17:50:40+03:00",
        "operating_reset_at": 1774623640,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object | array

Карта демо-шаблонов сайтов в формате:

{
    "template_code": site_template
}

где:

  • template_code — код шаблона
  • site_template — объект шаблона подробнее

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

Состав полей шаблонов может отличаться и зависит от конкретного шаблона

time
time

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

Тип шаблона сайта

Название
тип

Описание

ID
string

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

XML_ID
string

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

TYPE
string[] | string

Типы, для которых доступен шаблон.

Для файловых шаблонов обычно возвращается массив, для зарегистрированных шаблонов приложения — строка

TITLE
string

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

ACTIVE
boolean

Признак активности

PUBLICATION
boolean

Признак доступности публикации

LOCK_DELETE
boolean

Признак запрета удаления

AVAILABLE
boolean

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

SINGLETON
boolean

Признак одиночного шаблона

SECTION
string[]

Разделы шаблона

DESCRIPTION
string

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

PREVIEW
string

Preview 1x

PREVIEW2X
string

Preview 2x

PREVIEW3X
string

Preview 3x

APP_CODE
string

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

REST
integer

Признак REST-шаблона

DATA
object | array

Данные шаблона из файлового источника подробнее.

Для зарегистрированных шаблонов приложения может приходить пустой массив

Тип данных шаблона DATA

Название
тип

Описание

code
string

Код шаблона в данных экспорта

name
string

Название шаблона в данных экспорта

type
string[]

Типы шаблона.

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

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

description
string | null

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

active
boolean

Признак активности шаблона в данных экспорта

singleton
boolean

Признак одиночного шаблона в данных экспорта

lock_delete
boolean

Признак запрета удаления в данных экспорта

preview
string

Preview 1x в данных экспорта

preview2x
string

Preview 2x в данных экспорта

preview3x
string

Preview 3x в данных экспорта

preview_url
string

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

show_in_list
string

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

sort
integer

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

fields
object

Поля шаблона подробнее.

Коды fields.ADDITIONAL_FIELDS смотрите в разделе Дополнительные поля сайта

items
array | object

Состав шаблона подробнее

layout
array | object

Данные layout шаблона подробнее

folders
array | object

Папки шаблона подробнее

syspages
array | object

Системные страницы шаблона подробнее

master_pages
array

Список мастер-страниц шаблона подробнее

version
integer

Версия формата данных

old_id
integer | string

Исходный идентификатор

encoded
boolean

Добавляется методом со значением true, если в DATA есть поле items

charset
string

Добавляется методом со значением UTF-8, если в DATA есть поле items

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

ERROR_ARGUMENT

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

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

MISSING_PARAMS

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

Не передан обязательный параметр type

ACCESS_DENIED

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

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

TYPE_ERROR

Ошибка типа данных

Вызов метода с некорректным типом параметров

SYSTEM_ERROR

Внутренняя ошибка

Ошибка при выполнении метода на стороне сервера

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Зарегистрировать шаблон
Следующая
Получить список шаблонов для создания страниц