Get Additional Fields of the Site landing.site.getadditionalfields

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

The method landing.site.getadditionalfields retrieves additional fields of the site.

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.

The value of scope must correspond to the type of site (detailed description)

id*
integer

Identifier of the site.

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

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": 205
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getadditionalfields.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 205,
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.getadditionalfields.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.site.getadditionalfields',
        		{
        			id: 205
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.getadditionalfields',
                    [
                        'id' => 205,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting additional fields: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.site.getadditionalfields',
            {
                id: 205
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

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

Response Handling

HTTP Status: 200

Below is a shortened example of a response. The actual set of fields depends on the specific site settings.

{
            "result": {
                "COOKIES_USE": "Y",
                "COOKIES_AGREEMENT_ID": "19",
                "COOKIES_COLOR_BG": "#03c1fe",
                "COOKIES_COLOR_TEXT": "#fff",
                "COOKIES_POSITION": "bottom_left",
                "COOKIES_MODE": "I",
                "B24BUTTON_CODE": "https://cdn.com.bitrix24.com/b13743910/crm/site_button/loader_1_68znkz.js",
                "B24BUTTON_COLOR": "site",
                "B24BUTTON_COLOR_VALUE": "#03c1fe",
                "COPYRIGHT_SHOW": "Y",
                "COPYRIGHT_CODE": "6",
                "SETTINGS_PRICE_CODE": [
                    "BASE"
                ],
                "SETTINGS_SHOW_PRICE_COUNT": 1,
                "SETTINGS_CURRENCY_ID": "EUR",
                "SPEED_USE_LAZY": "Y",
                "THEME_CODE": "1construction",
                "THEME_COLOR": "#f7b70b",
                "YACOUNTER_USE": "Y",
                "YACOUNTER_COUNTER": "73521121",
                "ROBOTS_USE": "Y",
                "ROBOTS_CONTENT": "Disallow: /preview/*",
                "CSSBLOCK_USE": "N",
                "HEADBLOCK_USE": "N"
            },
            "time": {
                "start": 1773278929,
                "finish": 1773278929.806224,
                "duration": 0.8062241077423096,
                "processing": 0,
                "date_start": "2026-03-12T04:28:49+01:00",
                "date_finish": "2026-03-12T04:28:49+01:00",
                "operating_reset_at": 1773279529,
                "operating": 0.11928892135620117
            }
        }

Returned Data

Name
type

Description

result
object | array | null

A set of additional fields of the site in the format {"<FIELD_CODE>": "<VALUE>"}.

If there are no available fields, the method may return null or an empty array [] (detailed description)

time
time

Information about the execution time of the request

Result Object

Name
type

Description

<FIELD_CODE>
string | integer | boolean | array | object

Pair "field code → field value".

The value can be a string ("Y", "#03c1fe"), a number (1), or an array (for example, ["BASE"]).

The composition and type of the value depend on the specific additional field. Available field codes are described in the list of additional fields of the site

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Not enough 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`	Required parameter `id` is missing
`ACCESS_DENIED`	Insufficient rights to call the method
`TYPE_ERROR`	Data type error in the method call parameters
`SYSTEM_ERROR`	Internal error while executing 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 Public Site URL

Mark Site as Deleted

Get Additional Fields of the Site landing.site.getadditionalfields

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult 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

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning