Get a List of Included Areas for the Site landing.template.getSiteRef

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: user with "view" access permission for the site

The method landing.template.getSiteRef retrieves a list of included areas associated with the site.

The response includes only the bindings saved for the site. Bindings configured for individual pages of this site are not returned by the method. To obtain them, use landing.template.getLandingRef.

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

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 157
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.getSiteRef.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 157,
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.template.getSiteRef.json"
        
try
        {
            const response = await $b24.callMethod(
                'landing.template.getSiteRef',
                {
                    id: 157
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.template.getSiteRef',
                    [
                        'id' => 157,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting site refs: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.template.getSiteRef',
            {
                id: 157
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.template.getSiteRef',
            [
                'id' => 157,
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

If included areas are configured for the site, the method will return an object containing a list of these bindings. For each area, the identifier of the associated page is specified.

If no bindings for included areas are saved for the site, the method returns true.

{
            "result": {
                "1": 735,
                "2": 731
            },
            "time": {
                "start": 1774879192,
                "finish": 1774879192.923787,
                "duration": 0.9237871170043945,
                "processing": 0,
                "date_start": "2026-03-30T16:59:52+02:00",
                "date_finish": "2026-03-30T16:59:52+02:00",
                "operating_reset_at": 1774879792,
                "operating": 0
            }
        }
        
{
            "result": true,
            "time": {
                "start": 1774765200,
                "finish": 1774765200.411258,
                "duration": 0.4112579822540283,
                "processing": 0,
                "date_start": "2026-03-29T10:00:00+02:00",
                "date_finish": "2026-03-29T10:00:00+02:00",
                "operating_reset_at": 1774765800,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object | boolean

Bindings of the included areas of the site in the format {"<AREA_ID>": <PAGE_ID>}.

If bindings are saved for the site, the method returns an object. If there are no bindings, the method returns true (detailed description)

time
time

Information about the request execution time

Result Object

Name
type

Description

<AREA_ID>
integer

Identifier of the included area of the template. The value for this key contains the identifier of the page assigned to this area

Error Handling

HTTP Status: 400

{
            "error": "ENTITY_NOT_FOUND",
            "error_description": "Entity not found"
        }

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 id not provided

ENTITY_NOT_FOUND

Site not found or unavailable

ACCESS_DENIED

Insufficient rights to view the site

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

Previous
Get List of Included Areas for the Page
Next
Get List of Templates