Get a List of Registered Templates landing.demos.getList

{% note tip "" %}

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.

{% endnote %}

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

{% include Note on required parameters %}

#| || 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 {#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 info %}

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.

{% endnote %}

Code Examples

{% include Note on examples %}

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

{% list tabs %}

cURL (Webhook)

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

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"

JS (TS)

// 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)
}

JS (UMD)

<!-- 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>

PHP

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.js

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());
        }
    }
);

PHP CRest

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)
}

{% endlist %}

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 {#result-template}

#| || 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"
}

{% include notitle error handling %}

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 || |#

{% include system errors %}

Navigation Menu

Uh oh!

Get a List of Registered Templates landing.demos.getList

Method Parameters

Parameter params {#params}

Code Examples

Response Handling

Returned Data

Result Element Type {#result-template}

Error Handling

Possible Error Codes

Continue Learning

Uh oh!

FilesExpand file tree

landing-demos-get-list.md

Latest commit

History

landing-demos-get-list.md

File metadata and controls

Get a List of Registered Templates landing.demos.getList

Method Parameters

Parameter params {#params}

Code Examples

Response Handling

Returned Data

Result Element Type {#result-template}

Error Handling

Possible Error Codes

Continue Learning