Get the URL of the special page using landing.syspage.getSpecialPage

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.getSpecialPage returns the URL of the special page for the site.

Method Parameters

Required parameters are marked with *

Name `type`	Description
siteId* `integer`	The site identifier. The site identifier can be obtained using the method landing.site.getList or from the result of the method landing.site.add
type* `string`	The code of the special page that the method looks for in the site's bindings. The method searches for an exact match of the string, without trimming spaces and without normalizing the case. Possible values: `mainpage` — main page `catalog` — main catalog page `personal` — personal section `cart` — shopping cart `order` — order placement `payment` — payment page `compare` — comparison page `feedback` — feedback page The method landing.syspage.set removes spaces from the edges of the `type` value when saving. Therefore, in `landing.syspage.getSpecialPage`, the `type` parameter should be passed without extra spaces. Otherwise, the method may not find the required page. If a number, `true`, `false`, or `null` is passed instead of a string, the method will return an empty string `""`. If an array is passed, the request will result in an error
additional `object`	Additional URL parameters (detailed description). Each key-value pair is added to the final URL of the found page. By default, it is an empty object

Additional Parameter

The additional parameter adds extra parameters to the URL of the found page. It does not affect which page the method returns; the page is still determined solely by siteId and type.

Pass additional as an object in the format {"<parameter_name>": "<value>"}. All passed parameters will be added to the URL of the found page. If the page is not found, the parameter is not applied. If the URL already contains a parameter with that name, its value will be replaced.

Example:

{
            "siteId": 1390,
            "type": "personal",
            "additional": {
                "SECTION": "private",
                "utm_source": "newsletter"
            }
        }

Result:

https://b24-test.bitrix24.shop/personalsection/?SECTION=private&utm_source=newsletter

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 '{
            "siteId": 1390,
            "type": "personal",
            "additional": {
              "SECTION": "private"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.syspage.getSpecialPage.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1390,
            "type": "personal",
            "additional": {
              "SECTION": "private"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.syspage.getSpecialPage.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.syspage.getSpecialPage',
        		{
        			siteId: 1390,
        			type: 'personal',
        			additional: {
        				SECTION: 'private'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.syspage.getSpecialPage',
                    [
                        'siteId' => 1390,
                        'type' => 'personal',
                        'additional' => [
                            'SECTION' => 'private',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting special page URL: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.syspage.getSpecialPage',
            {
                siteId: 1390,
                type: 'personal',
                additional: {
                    SECTION: 'private'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.syspage.getSpecialPage',
            [
                'siteId' => 1390,
                'type' => 'personal',
                'additional' => [
                    'SECTION' => 'private',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": "https://btest.bitrix24.shop/personalsection/?SECTION=private",
            "time": {
                "start": 1774359422,
                "finish": 1774359422.588757,
                "duration": 0.5887570381164551,
                "processing": 0,
                "date_start": "2026-03-24T16:37:02+01:00",
                "date_finish": "2026-03-24T16:37:02+01:00",
                "operating_reset_at": 1774360022,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
string | null

URL of the special page.

If additional is passed and the page is found, the parameters will be added to the query string.

The method does not check if the page is active or marked as deleted. It returns null if the site is not found or if the user does not have "read" access permission for the site siteId.

An empty string "" is returned in two cases:

if no binding is found for the passed type,
if type is passed as something other than a string or an array

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Not enough call parameters, missing: type"
        }

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`	Required parameter `siteId`, `type`, or both parameters are missing
`ACCESS_DENIED`	Access to the method call is denied: insufficient rights to work with the Sites and Stores section
`ERROR_ARGUMENT`	An incorrect data type was passed in the `siteId`, `type`, or `additional` parameter
`SYSTEM_ERROR`	An internal error occurred during the execution of the method

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

Get List of Pages

Remove Page Bindings as Special

Get the URL of the special page using landing.syspage.getSpecialPage

Method ParametersMethod Parameters

Additional ParameterAdditional Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning