Get a List of Pages landing.landing.getList

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 landing pages. 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 choosing the value 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 `null`, `["*"]` is used. The method only accepts simple field names. 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 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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"

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

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": "Empty Page",
                    "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+02:00",
                "date_finish": "2026-03-17T04:56:00+02: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 was requested in `params.select` or if `params.select` was 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 that 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 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 call the method.
`TYPE_ERROR`	Data type error in the method 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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Retrieving Additional Fields

Getting the Path to the Page Preview

Get a List of Pages landing.landing.getList

Method ParametersMethod Parameters

Parameter paramsParameter params

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object pageObject page

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning