Get the URL of the special page using landing.syspage.getSpecialPage
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:
landingWho 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 |
Description |
|
siteId* |
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* |
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:
The method landing.syspage.set removes spaces from the edges of the If a number, |
|
additional |
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 -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"
// 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
try {
const response = await $b24.actions.v2.call.make<string | null>({
method: 'landing.syspage.getSpecialPage',
params: {
siteId: 1390,
type: 'personal',
additional: {
SECTION: 'private',
},
},
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(result)
}
} 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 getSpecialPage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.syspage.getSpecialPage',
params: {
siteId: 1390,
type: 'personal',
additional: {
SECTION: 'private',
},
},
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(result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSpecialPage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.syspage.get_special_page(
site_id=1390,
type="personal",
).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.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>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.syspage.getSpecialPage", b24.Params{
"siteId": 1390,
"type": "personal",
"additional": b24.Params{
"SECTION": "private",
},
})
if err != nil {
return fmt.Errorf("landing.syspage.getSpecialPage: %w", err)
}
var value string
if err := json.Unmarshal(res.Result, &value); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("result:", value)
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 |
Description |
|
result |
URL of the special page. If The method does not check if the page is active or marked as deleted. It returns An empty string
|
|
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Required parameter |
|
|
Access to the method call is denied: insufficient rights to work with the Sites and Stores section |
|
|
An incorrect data type was passed in the |
|
|
An internal error occurred during the execution of 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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |