Get a List of Registered Templates landing.demos.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:
landingWho 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 |
Description |
|
params |
Object format:
where:
For more details on each parameter, see the section Parameter params |
Parameter params
|
Name |
Description |
|
select |
Array format:
where:
For a list of available fields for selection, see the section Result element type. Elements in |
|
filter |
Object format:
where:
For a list of available fields for filtering, see the section Result element type. If |
|
order |
Object format:
where:
For a list of available fields for sorting, see the section Result element type |
|
group |
Array of fields for grouping the result. Format:
where:
Examples:
For a list of available fields, see the section Result element type |
|
limit |
Limit on the number of records in the selection |
|
offset |
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 responseparams.filter— conditions for filtering recordsparams.order— sorting the resultparams.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"
// 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 DemoItem returned in result[]
type DemoItem = {
ID: string
XML_ID: string
TITLE: string
TYPE: string
DATE_MODIFY: string
MANIFEST: object | boolean
}
try {
// landing.demos.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<DemoItem[]>({
method: 'landing.demos.getList',
params: {
params: {
select: ['ID', 'XML_ID', 'TITLE', 'TYPE', 'DATE_MODIFY'],
filter: { ACTIVE: 'Y' },
order: { ID: 'DESC' },
group: ['TYPE'],
},
start: 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('Demo templates:', 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 getDemoList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.demos.getList',
params: {
params: {
select: ['ID', 'XML_ID', 'TITLE', 'TYPE', 'DATE_MODIFY'],
filter: { ACTIVE: 'Y' },
order: { ID: 'DESC' },
group: ['TYPE'],
},
start: 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('Demo templates:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDemoList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.demos.get_list(
params={
"select": [
"ID",
"XML_ID",
"TITLE",
"TYPE",
"DATE_MODIFY",
],
"filter": {
"ACTIVE": "Y",
},
"order": {
"ID": "DESC",
},
"group": [
"TYPE",
],
},
).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.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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.demos.getList", b24.Params{
"params": b24.Params{
"select": []string{"ID", "XML_ID", "TITLE", "TYPE", "DATE_MODIFY"},
"filter": b24.Params{
"ACTIVE": "Y",
},
"order": b24.Params{
"ID": "DESC",
},
"group": []string{"TYPE"},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("landing.demos.getList: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
XMLID string `json:"XML_ID"`
Title string `json:"TITLE"`
Type string `json:"TYPE"`
DateModify string `json:"DATE_MODIFY"`
Manifest bool `json:"MANIFEST"`
}
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.XMLID)
}
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 |
Description |
|
result |
List of registered templates more details. If no matching records are found, the method returns |
|
time |
Information about the execution time of the request |
Result Element Type
|
Name |
Description |
|
Identifier of the template |
|
|
XML_ID |
External code of the template |
|
APP_CODE |
Application code |
|
ACTIVE |
Activity status ( |
|
TITLE |
Title of the template |
|
Description of the template |
|
|
TYPE |
Type of the template. Possible values:
|
|
TPL_TYPE |
Type of the wizard. Possible values:
|
|
SHOW_IN_LIST |
Indicator of display in the list ( |
|
PREVIEW_URL |
Link to preview |
|
PREVIEW |
Preview 1x |
|
PREVIEW2X |
Preview 2x |
|
PREVIEW3X |
Preview 3x |
|
Manifest of the template. In the original data, it is stored serialized, in the method response it is returned as an object after If the manifest is not specified, it may return |
|
|
Localization of the template. If the field is filled, it is returned in the response after The composition and keys of localization depend on the template. More details: Template Localization |
|
|
Identifier of the site template of the main module |
|
|
CREATED_BY_ID |
Identifier of the user who created the template |
|
MODIFIED_BY_ID |
Identifier of the user who modified the template |
|
DATE_CREATE |
Creation date. The method converts the value to a string |
|
DATE_MODIFY |
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
The value of an argument 'params' has an invalid type |
The parameter |
|
|
Insufficient permissions |
The user did not pass general access checks |
|
|
Data type error |
Method call with incorrect parameter types |
|
|
Internal error |
Error executing the method on the server side |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Register a Template in the Site Creation Wizard landing.demos.register
- Get a List of Templates for Creating Websites landing.demos.getSiteList
- Get a List of Templates for Creating Pages landing.demos.getPageList
- Delete Registered Template landing.demos.unregister
- Template Localization
- Custom Templates: Overview of Methods