Get a List of Registered Templates landing.demos.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 View access permission in the Sites section

The method landing.demos.getList retrieves a list of registered templates.

Method Parameters

Required parameters are marked with *

Name
type

Description

params
object

Object format:

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

where:

  • value_n — value of the corresponding selection parameter

For more details on each parameter, see the section Parameter params

Parameter params

Name
type

Description

select
string[]

Array format:

[
            field_1,
            field_2,
            ...,
            field_n
        ]

where:

  • field_n — selection field

For a list of available fields for selection, see the section Result element type.

Elements in select with a . are ignored

filter
object

Object format:

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

where:

  • field_n — filtering field
  • value_n — filter value

For a list of available fields for filtering, see the section Result element type.

If filter is not provided or is not in object format, the method uses an empty filter {}

order
object

Object format:

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

where:

  • field_n — sorting field
  • value_n — sorting direction: ASC or DESC

For a list of available fields for sorting, see the section Result element type

group
array

Array of fields for grouping the result.

Format:

[
            field_1,
            field_2,
            ...,
            field_n
        ]

where:

  • field_n — grouping field

Examples:

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

For a list of available fields, see the section Result element type

limit
integer

Limit on the number of records in the selection

offset
integer

Offset of records in the selection

Note

If the method is called in the context of an application, the server additionally adds a filter for the current application.

In this case, only templates created by the same application will be included in the response.

When called outside the application context, this filter is not added.

Code Examples

How to Use Examples in Documentation

Example of retrieving a list of templates, where:

  • params.select — fields to return in the response
  • params.filter — conditions for filtering records
  • params.order — sorting the result
  • params.group — grouping fields
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"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.demos.getList',
        		{
        			params: {
        				select: ['ID', 'XML_ID', 'TITLE', 'TYPE', 'DATE_MODIFY'],
        				filter: { ACTIVE: 'Y' },
        				order: { ID: 'DESC' },
        				group: ['TYPE']
        			}
        		}
        	);
        
        	console.info(response.getData().result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
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>';

Response Handling

HTTP status: 200

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

Returned Data

Name
type

Description

result
object[]

List of registered templates more details.

If no matching records are found, the method returns result: []

time
time

Information about the execution time of the request

Result Element Type

Name
type

Description

ID
integer | string

Identifier of the template

XML_ID
string

External code of the template

APP_CODE
string

Application code

ACTIVE
string

Activity status (Y/N)

TITLE
string

Title of the template

DESCRIPTION
string | null

Description of the template

TYPE
string

Type of the template.

Possible values:

  • page — templates for pages/sites
  • store — templates for stores
  • knowledge — templates for knowledge bases
  • group — templates for groups
  • mainpage — templates for main pages

TPL_TYPE
string

Type of the wizard.

Possible values:

  • S — site template
  • P — page template

SHOW_IN_LIST
string

Indicator of display in the list (Y/N)

PREVIEW_URL
string

Link to preview

PREVIEW
string

Preview 1x

PREVIEW2X
string

Preview 2x

PREVIEW3X
string

Preview 3x

MANIFEST
object | boolean

Manifest of the template.

In the original data, it is stored serialized, in the method response it is returned as an object after unserialize.

If the manifest is not specified, it may return false

LANG
object | null

Localization of the template.

If the field is filled, it is returned in the response after unserialize.

The composition and keys of localization depend on the template. More details: Template Localization

SITE_TEMPLATE_ID
string | null

Identifier of the site template of the main module

CREATED_BY_ID
integer

Identifier of the user who created the template

MODIFIED_BY_ID
integer

Identifier of the user who modified the template

DATE_CREATE
string

Creation date.

The method converts the value to a string

DATE_MODIFY
string

Modification date.

The method converts the value to a string

Error Handling

HTTP status: 400

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

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

Value

ERROR_ARGUMENT

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

The parameter params is passed in an incorrect type

ACCESS_DENIED

Insufficient permissions

The user did not pass general access checks

TYPE_ERROR

Data type error

Method call with incorrect parameter types

SYSTEM_ERROR

Internal error

Error executing the method on the server side

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

Previous
Get a List of Templates for Page Creation
Next
Unregister a Template