Get a List of View Templates landing.template.getlist

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.

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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"

try
        {
            const response = await $b24.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
                    }
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.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>';
        }

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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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

Get List of Included Areas for the Site

Set Included Areas for the Page

Get a List of View Templates landing.template.getlist

Method ParametersMethod Parameters

Parameter paramsParameter params

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object templateObject template

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter params

Code Examples

Response Handling

Returned Data

Object template

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning