Получить список шаблонов представления landing.template.getlist

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

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

Scope: landing

Кто может выполнять метод: пользователь с правом доступа к разделу «Сайты и магазины»

Метод landing.template.getlist получает список шаблонов представления текущего портала по параметрам выборки.

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

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

Название
тип

Описание

params
object

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

{
    "select": ["поле_1", "поле_2"],
    "filter": {
        "поле": "значение"
    },
    "order": {
        "поле": "ASC"
    },
    "group": ["поле"],
    "limit": 50,
    "offset": 0
}

Список доступных полей описан ниже

Параметр params

Название
тип

Описание

select
string[]

Список полей из полей объекта Шаблон представления.

Если параметр не передан, метод возвращает все доступные поля шаблона.

Поля вида CREATED_BY.NAME не поддерживаются

filter
object

Фильтр по полям из полей объекта Шаблон представления.

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

Поля вида CREATED_BY.NAME не поддерживаются

order
object

Сортировка в формате {"FIELD": "ASC"} или {"FIELD": "DESC"}.

Можно передать несколько полей. Если параметр не передан, метод не задает собственную сортировку

group
array

Массив имен полей для группировки, например ["ACTIVE"] или ["ACTIVE", "SORT"].

Вычисляемые поля через runtime не поддерживаются

limit
integer

Максимальное количество элементов в ответе.

Если limit не указан, метод возвращает все найденные шаблоны без ограничения. Используйте вместе с offset для постраничной выборки

offset
integer

Смещение от начала выборки. Используйте вместе с limit для постраничной выборки

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "select": [
        "ID",
        "TITLE",
        "XML_ID",
        "SORT",
        "ACTIVE",
        "DATE_MODIFY"
      ],
      "filter": {
        "=ACTIVE": "Y"
      },
      "order": {
        "SORT": "ASC",
        "ID": "ASC"
      },
      "limit": 2,
      "offset": 0
    }
  }' \
  "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.getlist.json"
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "select": [
        "ID",
        "TITLE",
        "XML_ID",
        "SORT",
        "ACTIVE",
        "DATE_MODIFY"
      ],
      "filter": {
        "=ACTIVE": "Y"
      },
      "order": {
        "SORT": "ASC",
        "ID": "ASC"
      },
      "limit": 2,
      "offset": 0
    },
    "auth": "**put_access_token_here**"
  }' \
  "https://**put.your-domain-here**/rest/landing.template.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 template item returned in result[]
type TemplateItem = {
  ID: string
  TITLE: string
  XML_ID: string
  SORT: string
  ACTIVE: string
  DATE_MODIFY: string
}

try {
  // landing.template.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<TemplateItem[]>({
    method: 'landing.template.getlist',
    params: {
      params: {
        select: [
          'ID',
          'TITLE',
          'XML_ID',
          'SORT',
          'ACTIVE',
          'DATE_MODIFY',
        ],
        filter: {
          '=ACTIVE': 'Y',
        },
        order: {
          SORT: 'ASC',
          ID: 'ASC',
        },
        limit: 2,
        offset: 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('Templates count:', 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 getTemplateList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // landing.template.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({
        method: 'landing.template.getlist',
        params: {
          params: {
            select: [
              'ID',
              'TITLE',
              'XML_ID',
              'SORT',
              'ACTIVE',
              'DATE_MODIFY',
            ],
            filter: {
              '=ACTIVE': 'Y',
            },
            order: {
              SORT: 'ASC',
              ID: 'ASC',
            },
            limit: 2,
            offset: 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('Templates count:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getTemplateList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.landing.template.getlist(
        params={
            "select": [
                "ID",
                "TITLE",
                "XML_ID",
                "SORT",
                "ACTIVE",
                "DATE_MODIFY",
            ],
            "filter": {
                "=ACTIVE": "Y",
            },
            "order": {
                "SORT": "ASC",
                "ID": "ASC",
            },
            "limit": 2,
            "offset": 0,
        },
    ).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.template.getlist',
            [
                'params' => [
                    'select' => [
                        'ID',
                        'TITLE',
                        'XML_ID',
                        'SORT',
                        'ACTIVE',
                        'DATE_MODIFY',
                    ],
                    'filter' => [
                        '=ACTIVE' => 'Y',
                    ],
                    'order' => [
                        'SORT' => 'ASC',
                        'ID' => 'ASC',
                    ],
                    'limit' => 2,
                    'offset' => 0,
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting template list: ' . $e->getMessage();
}
BX24.callMethod(
    'landing.template.getlist',
    {
        params: {
            select: [
                'ID',
                'TITLE',
                'XML_ID',
                'SORT',
                'ACTIVE',
                'DATE_MODIFY'
            ],
            filter: {
                '=ACTIVE': 'Y'
            },
            order: {
                SORT: 'ASC',
                ID: 'ASC'
            },
            limit: 2,
            offset: 0
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'landing.template.getlist',
    [
        'params' => [
            'select' => [
                'ID',
                'TITLE',
                'XML_ID',
                'SORT',
                'ACTIVE',
                'DATE_MODIFY',
            ],
            'filter' => [
                '=ACTIVE' => 'Y',
            ],
            'order' => [
                'SORT' => 'ASC',
                'ID' => 'ASC',
            ],
            'limit' => 2,
            'offset' => 0,
        ],
    ]
);

if (isset($result['error']))
{
    echo 'Ошибка: ' . $result['error_description'];
}
else
{
    echo '<pre>';
    print_r($result['result']);
    echo '</pre>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.template.getlist", b24.Params{
	"params": b24.Params{
		"select": []string{"ID", "TITLE", "XML_ID", "SORT", "ACTIVE", "DATE_MODIFY"},
		"filter": b24.Params{
			"=ACTIVE": "Y",
		},
		"order": b24.Params{
			"SORT": "ASC",
			"ID":   "ASC",
		},
		"limit":  2,
		"offset": 0,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("landing.template.getlist: %w", err)
}

var items []struct {
	ID         b24.ID `json:"ID"`
	Title      string `json:"TITLE"`
	XMLID      string `json:"XML_ID"`
	Sort       string `json:"SORT"`
	Active     string `json:"ACTIVE"`
	DateModify string `json:"DATE_MODIFY"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.Title)
}

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

HTTP-статус: 200

{
    "result": [
        {
            "ID": "1",
            "TITLE": "С шапкой и подвалом",
            "XML_ID": "header_footer",
            "SORT": "100",
            "ACTIVE": "Y",
            "DATE_MODIFY": "10/10/2022 03:25:30 pm"
        },
        {
            "ID": "2",
            "TITLE": "С сайдбаром слева",
            "XML_ID": "sidebar_left",
            "SORT": "200",
            "ACTIVE": "Y",
            "DATE_MODIFY": "10/10/2022 03:25:30 pm"
        }
    ],
    "time": {
        "start": 1774765200,
        "finish": 1774765200.411258,
        "duration": 0.4112579822540283,
        "processing": 0,
        "date_start": "2026-03-29T10:00:00+03:00",
        "date_finish": "2026-03-29T10:00:00+03:00",
        "operating_reset_at": 1774765800,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object[]

Список шаблонов представления (подробное описание).

Если по фильтру ничего не найдено, метод возвращает result: []

time
time

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

Объект template

Название
тип

Описание

FIELD
string | integer | null

Поле шаблона представления из полей объекта Шаблон представления, если оно попало в выборку.

Для полей DATE_CREATE и DATE_MODIFY метод всегда возвращает строку, например 04/20/2020 12:48:10 pm

Особенности ответа:

  • Поле TITLE обычно возвращается как название на текущем языке портала
  • Если для системного шаблона не найден перевод, в TITLE может вернуться языковой ключ вида #...#, например #HEADER_ONLY#

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

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Недостаточно прав."
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

ACCESS_DENIED

Недостаточно прав для работы с разделом «Сайты и магазины»

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

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

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