Get Additional Fields of the Site landing.site.getadditionalfields
Scope:
landingWho 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 |
Description |
|
id* |
Site identifier. 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 -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 the 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 |
Description |
|
A set of additional fields of the site in the format If there are no available fields, the method may return |
|
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
Pair "field code → field value". The value can be a string ( 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": "Insufficient call parameters, missing: id"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
The required parameter |
|
|
Insufficient permissions to call the method |
|
|
Data type error in the method call parameters |
|
|
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 |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Site landing.site.add
- Update Site landing.site.update
- Get Site Folders landing.site.getFolders
- Get the List of Sites landing.site.getList
- Get URL Preview of the landing.site.getPreview
- Get Public URL of the Site landing.site.getPublicUrl