Site settings

GET /v1/sites/:id/settings

Hook keys stay unchanged. HTML/JS values are JSON data: do not execute them. Bitrix24 omits empty values. An existing site with no configured values returns data: {}. The sites entity does not declare ADDITIONAL_FIELDS; PATCH /v1/sites/:id provides no dedicated write contract for these settings.

Parameters

Parameter	Type	Required	Description
id	integer	yes	Positive safe integer site ID
scope	string	no	KNOWLEDGE / GROUP / MAINPAGE; omit for ordinary sites

Requires landing key scope. A knowledge-base or group site can be invisible without scope.

curl

Terminal

curl -X GET "https://vibecode.bitrix24.com/v1/sites/42/settings" -H "X-Api-Key: YOUR_API_KEY"

JavaScript

javascript

const response = await fetch("https://vibecode.bitrix24.com/v1/sites/42/settings", {
  method: "GET",
  headers: { "X-Api-Key": "YOUR_API_KEY" },
});
const data = await response.json();

Response

JSON

{
  "success": true,
  "data": {
    "HEADBLOCK_CODE": "<meta name=\"example\" content=\"data\">"
  }
}

Errors

400 INVALID_PARAMS / INVALID_SCOPE; 401 TOKEN_MISSING; 403 SCOPE_DENIED / BITRIX_ACCESS_DENIED; 404 ENTITY_NOT_FOUND; 409 LANDING_MODULE_NOT_ENABLED; 422 BITRIX_ERROR; 429 rate limits; 502 / 503 upstream or transport refusal. Write operations with a READONLY key return 403 WRITE_BLOCKED_READONLY_KEY.

Bitrix24: landing.site.getadditionalfields.

Sites