لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/entities/pages/settings.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Page settings

GET /v1/pages/:id/settings

Returns additional page settings: meta tags, view, theme and catalog parameters.

Requires the landing scope. A read-only key receives a response.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionPage ID. List: GET /v1/pages
Parameterscope (query) Typestring Requiredno DescriptionSite type: KNOWLEDGE — knowledge base, GROUP — workgroup site, MAINPAGE — main page. Omit the parameter for pages of other sites

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/pages/7/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/7/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/7/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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionPage settings. The key is the setting name in camelCase: group plus name, for example metaog and Title give metaogTitle. The value is a string, a number or an array; flags arrive as the string Y or N. The set of keys differs between pages
Fielddata.metamainUse Typestring DescriptionWhether meta tags for search engines are enabled: Y or N
Fielddata.metamainTitle Typestring DescriptionPage title for search engines
Fielddata.metamainDescription Typestring DescriptionPage description for search engines
Fielddata.metaogTitle Typestring DescriptionTitle for the link preview in social networks and messengers
Fielddata.metaogImage Typestring DescriptionImage for the link preview: a file ID as a string, for example "1223", or a full URL
Fielddata.metarobotsIndex Typestring DescriptionY — search engines may index the page, N — they may not
Fielddata.settingsPriceCode Typearray DescriptionPrice type codes for catalog blocks
Fielddata.settingsCurrencyId Typestring DescriptionPrice currency in catalog blocks
Fielddata.themefontsCode Typestring DescriptionFont code for the page text, for example g-font-roboto
Fielddata.viewType Typestring DescriptionPage view type, for example adaptive or no

Response example

Main fields are shown:

JSON 
{
  "success": true,
  "data": {
    "metamainUse": "N",
    "metamainTitle": "Photography",
    "metamainDescription": "Do you do professional photography? Tell people about yourself, show clients your portfolio, and they will not keep you waiting!",
    "metaogTitle": "Photography",
    "metaogImage": "https://cdn.bitrix24.site/bitrix/images/demo/page/photography/preview.jpg",
    "metarobotsIndex": "Y",
    "settingsPriceCode": [
      "BASE"
    ],
    "settingsCurrencyId": "USD",
    "themefontsCode": "g-font-roboto",
    "viewType": "no"
  }
}

Error response example

404 — no page with this id:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Page not found."
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionPage not found. — no page with this id
HTTP404 CodeENTITY_NOT_FOUND DescriptionPage or folder not found. — Bitrix24 did not find the page while reading its settings
HTTP400 CodeINVALID_PAGE_ID Descriptionid must be a positive safe integer. — id is not a positive integer
HTTP400 CodeINVALID_SCOPE Descriptionscope must be KNOWLEDGE, GROUP or MAINPAGE, or omitted. — scope is not KNOWLEDGE, GROUP or MAINPAGE
HTTP422 CodeBITRIX_NO_EFFECT DescriptionBitrix24 did not return page settings. — Bitrix24 did not return the page settings
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the request. The error text comes from Bitrix24
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the landing scope
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe Bitrix24 user on whose behalf the key was issued has no permission to read the page
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe key in X-Api-Key was not found or has been revoked
HTTP409 CodePORTAL_ADDRESS_CHANGED DescriptionThe on-premise Bitrix24 moved to a new address, but the key's webhook was issued for the old one. Reissue the key's webhook
HTTP429 CodeRATE_LIMITED DescriptionThe Bitrix24 request limit was exceeded. Retry the request in 1-2 seconds
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 did not respond or responded with a server error
HTTP503 CodeBITRIX_TIMEOUT DescriptionBitrix24 did not respond within the allotted time

Full list of common API errors — Errors.

Known specifics

  • Values containing HTML code arrive as raw strings. For example, fontsCode contains font loading tags. Do not insert such values into your page without checking them.
  • Secrets are removed from the settings. A setting is left out of the response if its name contains password or secret, or one of the separate words auth, token, access_token, refresh_token or api_key. A string with a webhook URL or with an auth= or token= parameter arrives entirely as [REDACTED]. Other values arrive unchecked.

See also