Get a List of Pages landing.landing.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 "view" access permission for the site

The method landing.landing.getList retrieves a list of pages based on the selection parameters.

Warning

By default, the method returns only pages on non-deleted sites with DELETED = "N". To retrieve deleted pages, pass DELETED or =DELETED in the filter. This only works for pages on non-deleted sites: the method does not return pages from deleted sites.

Method Parameters

Required parameters are marked with *

Name
type

Description

scope
string

Internal scope of the landings. It is not related to the REST scope landing in the method name.

For regular pages, this parameter is not needed. For GROUP, KNOWLEDGE, and MAINPAGE, pass the corresponding scope. More about selecting values can be found in the article Working with Site Types and Scopes

params
object

Parameters for selecting pages (detailed description)

Parameter params

Name
type

Description

select
string[]

List of fields to select from Page Object Fields. If the parameter is not passed or is equal to null, ["*"] is used.

The method only accepts simple field names of the page. Elements with . are ignored.

filter
object

Filter by fields from Page Object Fields. If the parameter is not passed or is in an incorrect format, the selection is performed without custom conditions. Keys with . and CHECK_PERMISSIONS are ignored.

If SITE_ID is passed in the filter, the method additionally excludes pages that are in folders of that site marked as deleted.

The site identifier can be obtained using the method landing.site.getList

order
object

Sorting in the format {"FIELD": "ASC"} or {"FIELD": "DESC"}. If the parameter is not passed, no special sorting is applied.

group
array

Grouping in ORM format. The method does not have a default value.

limit
integer

Limit on the number of rows in the selection at the ORM level. The method does not set its own default limit.

offset
integer

Offset for the selection at the ORM level.

get_preview
boolean | integer

If the value evaluates to true, each result element includes a PREVIEW field with a link to the page preview.

get_urls
boolean | integer

If the value evaluates to true, each result element includes a PUBLIC_URL field with the public address of the page.

check_area
boolean | integer

If the value evaluates to true, each result element includes an IS_AREA field indicating whether the page is an included area.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": [
                "ID",
                "TITLE",
                "SITE_ID",
                "DATE_MODIFY"
              ],
              "filter": {
                "SITE_ID": 205,
                "=DELETED": "N"
              },
              "order": {
                "ID": "DESC"
              },
              "get_urls": true,
              "get_preview": true,
              "check_area": true
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.getList.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": [
                "ID",
                "TITLE",
                "SITE_ID",
                "DATE_MODIFY"
              ],
              "filter": {
                "SITE_ID": 205,
                "=DELETED": "N"
              },
              "order": {
                "ID": "DESC"
              },
              "get_urls": true,
              "get_preview": true,
              "check_area": true
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.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 LandingItem returned in result[]
        type LandingItem = {
          ID: string
          TITLE: string
          SITE_ID: string
          DATE_MODIFY: string
          DOMAIN_ID: string | null
          PUBLIC_URL?: string | null
          PREVIEW?: string | null
          IS_AREA?: boolean
        }
        
        try {
          // landing.landing.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<LandingItem[]>({
            method: 'landing.landing.getList',
            params: {
              params: {
                select: [
                  'ID',
                  'TITLE',
                  'SITE_ID',
                  'DATE_MODIFY',
                ],
                filter: {
                  SITE_ID: 205,
                  '=DELETED': 'N',
                },
                order: {
                  ID: 'DESC',
                },
                get_urls: true,
                get_preview: true,
                check_area: true,
              },
              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('Pages count:', result.length, 'First page:', result[0])
          }
        } 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 getLandingList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // landing.landing.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.landing.getList',
                params: {
                  params: {
                    select: [
                      'ID',
                      'TITLE',
                      'SITE_ID',
                      'DATE_MODIFY',
                    ],
                    filter: {
                      SITE_ID: 205,
                      '=DELETED': 'N',
                    },
                    order: {
                      ID: 'DESC',
                    },
                    get_urls: true,
                    get_preview: true,
                    check_area: true,
                  },
                  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('Pages count:', result.length, 'First page:', result[0])
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getLandingList)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.landing.get_list(
                params={
                    "select": [
                        "ID",
                        "TITLE",
                        "SITE_ID",
                        "DATE_MODIFY",
                    ],
                    "filter": {
                        "SITE_ID": 205,
                        "=DELETED": "N",
                    },
                    "order": {
                        "ID": "DESC",
                    },
                    "get_urls": True,
                    "get_preview": True,
                    "check_area": True,
                },
            ).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.landing.getList',
                    [
                        'params' => [
                            'select' => [
                                'ID',
                                'TITLE',
                                'SITE_ID',
                                'DATE_MODIFY',
                            ],
                            'filter' => [
                                'SITE_ID' => 205,
                                '=DELETED' => 'N',
                            ],
                            'order' => [
                                'ID' => 'DESC',
                            ],
                            'get_urls' => true,
                            'get_preview' => true,
                            'check_area' => true,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting landing list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.landing.getList',
            {
                params: {
                    select: [
                        'ID',
                        'TITLE',
                        'SITE_ID',
                        'DATE_MODIFY'
                    ],
                    filter: {
                        SITE_ID: 205,
                        '=DELETED': 'N'
                    },
                    order: {
                        ID: 'DESC'
                    },
                    get_urls: true,
                    get_preview: true,
                    check_area: true
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.landing.getList',
            [
                'params' => [
                    'select' => [
                        'ID',
                        'TITLE',
                        'SITE_ID',
                        'DATE_MODIFY',
                    ],
                    'filter' => [
                        'SITE_ID' => 205,
                        '=DELETED' => 'N',
                    ],
                    'order' => [
                        'ID' => 'DESC',
                    ],
                    'get_urls' => true,
                    'get_preview' => true,
                    'check_area' => true,
                ],
            ]
        );
        
        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.landing.getList", b24.Params{
        	"params": b24.Params{
        		"select": []string{"ID", "TITLE", "SITE_ID", "DATE_MODIFY"},
        		"filter": b24.Params{
        			"SITE_ID":  205,
        			"=DELETED": "N",
        		},
        		"order": b24.Params{
        			"ID": "DESC",
        		},
        		"get_urls":    true,
        		"get_preview": true,
        		"check_area":  true,
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("landing.landing.getList: %w", err)
        }
        
        var items []struct {
        	ID         b24.ID `json:"ID"`
        	Title      string `json:"TITLE"`
        	SiteID     b24.ID `json:"SITE_ID"`
        	DateModify string `json:"DATE_MODIFY"`
        	DomainID   b24.ID `json:"DOMAIN_ID"`
        }
        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": "985",
                    "TITLE": "Detailed News",
                    "SITE_ID": "3",
                    "DATE_MODIFY": "10/10/2022 03:25:30 pm",
                    "DOMAIN_ID": "5"
                },
                {
                    "ID": "573",
                    "TITLE": "Page Video",
                    "SITE_ID": "3",
                    "DATE_MODIFY": "10/10/2022 03:25:30 pm",
                    "DOMAIN_ID": "5"
                }
            ],
            "time": {
                "start": 1773712560,
                "finish": 1773712560.955928,
                "duration": 0.9559280872344971,
                "processing": 0,
                "date_start": "2026-03-17T04:56:00+01:00",
                "date_finish": "2026-03-17T04:56:00+01:00",
                "operating_reset_at": 1773713160,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object[]

List of pages (detailed description). The method may return result: [] without an error if there are no matching pages for the filter or if the user does not have "view" access permission for these sites.

time
time

Information about the execution time of the request.

Object page

Name
type

Description

FIELD
string | null

Any field of the page from Page Object Fields, if it is requested in params.select or if params.select is not passed.

DOMAIN_ID
string | null

Identifier of the domain of the site to which the page is linked. Present in the response even if it is not specified in params.select.

PUBLIC_URL
string | null

Public address of the page. Returned only if the get_urls flag is enabled.

PREVIEW
string | null

Link to the page preview. Returned only if the get_preview flag is enabled.

IS_AREA
boolean

Indicates whether the page is used as an included area. Returned only if the check_area flag is enabled.

Error Handling

HTTP Status: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied"
        }
        

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 call the method.

TYPE_ERROR

Data type error in the method call parameters.

SYSTEM_ERROR

Internal error while executing the method.

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