Get a List of View Templates landing.template.getlist

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: landing

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

The method landing.template.getlist retrieves a list of view templates for the current account based on the selection parameters.

Method Parameters

Required parameters are marked with *

Name
type

Description

params
object

An object containing the selection parameters for view templates in the following format:

{
            "select": ["field_1", "field_2"],
            "filter": {
                "field": "value"
            },
            "order": {
                "field": "ASC"
            },
            "group": ["field"],
            "limit": 50,
            "offset": 0
        }
        

The list of available fields is described below

Parameter params

Name
type

Description

select
string[]

A list of fields from the fields of the View Template object.

If the parameter is not provided, the method returns all available fields of the template.

Fields like CREATED_BY.NAME are not supported

filter
object

A filter for fields from the fields of the View Template object.

If the parameter is not provided, the method returns all templates of the current account, including inactive ones.

Fields like CREATED_BY.NAME are not supported

order
object

Sorting in the format {"FIELD": "ASC"} or {"FIELD": "DESC"}.

Multiple fields can be provided. If the parameter is not provided, the method does not apply any sorting

group
array

An array of field names for grouping, such as ["ACTIVE"] or ["ACTIVE", "SORT"].

Calculated fields via runtime are not supported

limit
integer

The maximum number of items in the response.

If limit is not specified, the method returns all found templates without restriction. Use together with offset for pagination

offset
integer

The offset from the start of the selection. Use together with limit for pagination

Code Examples

How to Use Examples in Documentation

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 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}")
        
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 '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.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("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.Title)
        }
        

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "ID": "1",
                    "TITLE": "With Header and Footer",
                    "XML_ID": "header_footer",
                    "SORT": "100",
                    "ACTIVE": "Y",
                    "DATE_MODIFY": "10/10/2022 03:25:30 pm"
                },
                {
                    "ID": "2",
                    "TITLE": "With Left Sidebar",
                    "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+02:00",
                "date_finish": "2026-03-29T10:00:00+02:00",
                "operating_reset_at": 1774765800,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object[]

A list of view templates (detailed description).

If nothing is found by the filter, the method returns result: []

time
time

Information about the execution time of the request

Object template

Name
type

Description

FIELD
string | integer | null

A field of the view template from the fields of the View Template object, if it was included in the selection.

For the fields DATE_CREATE and DATE_MODIFY, the method always returns a string, for example 04/20/2020 12:48:10 pm

Response Features:

  • The TITLE field is usually returned as the name in the current language of the account
  • If a translation for a system template is not found, the TITLE may return a language key like #...#, for example #HEADER_ONLY#

Error Handling

HTTP Status: 400

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

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

ACCESS_DENIED

Insufficient permissions to work with the "Sites and Stores" section

TYPE_ERROR

Data type error while processing the call parameters

SYSTEM_ERROR

Internal error during method execution

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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