Get a List of Special Pages from landing.syspage.get

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 "read" access permission for the site

The method landing.syspage.get returns a list of special pages for the site.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the site.

The site identifier can be obtained using the landing.site.getList method or from the result of the landing.site.add method

active
boolean

Return only pages that are not deleted and are active.

The filter is considered enabled if true is passed. By default, it is false

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 '{
            "id": 1390,
            "active": true
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.syspage.get.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 1390,
            "active": true,
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.syspage.get.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.syspage.get',
        		{
        			id: 1390,
        			active: true
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.syspage.get',
                    [
                        'id' => 1390,
                        'active' => true,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting special pages: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.syspage.get',
            {
                id: 1390,
                active: true
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.syspage.get',
            [
                'id' => 1390,
                'active' => true,
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": {
                "mainpage": {
                    "TYPE": "mainpage",
                    "LANDING_ID": "711",
                    "TITLE": "Classic Store. Clothing",
                    "DELETED": "N",
                    "ACTIVE": "Y"
                },
                "catalog": {
                    "TYPE": "catalog",
                    "LANDING_ID": "713",
                    "TITLE": "Catalog",
                    "DELETED": "N",
                    "ACTIVE": "Y"
                },
                "personal": {
                    "TYPE": "personal",
                    "LANDING_ID": "717",
                    "TITLE": "Personal Section",
                    "DELETED": "N",
                    "ACTIVE": "Y"
                },
                "cart": {
                    "TYPE": "cart",
                    "LANDING_ID": "2261",
                    "TITLE": "Cart",
                    "DELETED": "N",
                    "ACTIVE": "Y"
                },
                "order": {
                    "TYPE": "order",
                    "LANDING_ID": "721",
                    "TITLE": "Order Checkout",
                    "DELETED": "N",
                    "ACTIVE": "Y"
                },
                "compare": {
                    "TYPE": "compare",
                    "LANDING_ID": "749",
                    "TITLE": "Comparison",
                    "DELETED": "N",
                    "ACTIVE": "Y"
                },
                "payment": {
                    "TYPE": "payment",
                    "LANDING_ID": "751",
                    "TITLE": "Order Payment",
                    "DELETED": "N",
                    "ACTIVE": "Y"
                }
            },
            "time": {
                "start": 1774349441,
                "finish": 1774349441.726663,
                "duration": 0.7266631126403809,
                "processing": 0,
                "date_start": "2026-03-24T13:50:41+01:00",
                "date_finish": "2026-03-24T13:50:41+01:00",
                "operating_reset_at": 1774350041,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
any

The result of the request execution.

The method returns an object with special pages grouped by type code (detailed description).

If the site is not found or the user does not have "read" access permission for the site, the method will return null.

If access to the site is available but no special pages are assigned, the method will return an empty object {}. The same response will be returned if the filter active = true is enabled and no pages match it

time
time

Information about the request execution time

Result Object

Name
type

Description

type code
object

Object binding of the special page (detailed description)

Key of the result object.

Possible values:
mainpage — main page
catalog — main catalog page
personal — personal section
cart — cart
order — order checkout
payment — payment page
compare — comparison page
feedback — feedback page

Special Page Binding Object

Name `type`	Description
TYPE `string`	Code of the special page type. The value matches the key in the `result` object
LANDING_ID `string`	Identifier of the page designated as special for the site. Returned as a string in the response
TITLE `string`	Title of the page
DELETED `string`	Flag indicating if the page is deleted. Possible values: `Y` — page is deleted `N` — page is not deleted
ACTIVE `string`	Flag indicating if the page is active. Possible values: `Y` — page is active `N` — page is inactive

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Insufficient call parameters, missing: id"
        }

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
`MISSING_PARAMS`	The required parameter `id` was not provided
`ACCESS_DENIED`	Access to the method call is denied: the user does not have access to the method or the `landing` module
`TYPE_ERROR`	Data type error in the `id` parameter
`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 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

Set Special Page

Get Address of Special Page

Get a List of Special Pages from landing.syspage.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Special Page Binding ObjectSpecial Page Binding Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Code Examples

Response Handling

Returned Data

Result Object

Special Page Binding Object

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning