Untuk agen AI: markdown halaman ini — /docs-content-en/entities/pages/settings.md indeks dokumentasi — /llms.txt

Artikel dokumentasi saat ini tersedia dalam bahasa Inggris.

Page settings

GET /v1/pages/:id/settings

Returns additional hook settings in camelCase. Bitrix24 omits empty and zero values, so empty and unset are indistinguishable. HTML and JS are data and must not be executed. Credential URLs are redacted; password and token fields are omitted.

Requires the landing scope. Available to a READONLY key.

Request parameters

Field Type Required Description
id integer yes Page ID from List pages.
scope string no Query: KNOWLEDGE, GROUP or MAINPAGE; omit for an ordinary site.

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/pages/42/settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch("https://vibecode.bitrix24.com/v1/pages/42/settings", {
  method: "GET",
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

JavaScript — OAuth application

javascript 
const response = await fetch("https://vibecode.bitrix24.com/v1/pages/42/settings", {
  method: "GET",
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

Response fields

Field Type Description
success boolean true
data object Operation result.
data.settingsPriceCode array Price-code setting; other camelCase fields depend on hooks.
JSON 
{
  "success": true,
  "data": {
    "settingsPriceCode": [
      "BASE"
    ]
  }
}

Errors

HTTP Code Condition
400 INVALID_PAGE_ID id is not a positive safe integer.
400 INVALID_PARAMS Invalid body shape or parameter value.
400 INVALID_SCOPE Invalid scope.
401 TOKEN_MISSING No Bitrix24 credentials.
403 SCOPE_DENIED The key lacks landing.
403 BITRIX_ACCESS_DENIED The Bitrix24 user lacks permission.
404 ENTITY_NOT_FOUND Page not found.
422 BITRIX_ERROR Bitrix24 business refusal; its message is preserved.
422 BITRIX_NO_EFFECT Bitrix24 did not confirm the action or return the expected result.

All system errors.

400 — invalid scope:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_SCOPE",
    "message": "scope must be KNOWLEDGE, GROUP or MAINPAGE, or omitted."
  }
}

See also